Branches & Merging
Branches are used to develop and test new versions of your Business Logic and API. You can Merge Branches for seamless development workflows.
Last updated
Branches are used to develop and test new versions of your Business Logic and API. You can Merge Branches for seamless development workflows.
Last updated
A Branch is a copy of a workspace's business logic (APIs, Functions, Addons, and Tasks). They are most useful for testing and developing new versions of your app without affecting your customers' primary experience.
You can create new Branches and select which Branch to make a copy of, choose which Branch to make edits to, and select which Branch you want to be live for your API.
Branches can also merge from a source Branch to a destination Branch to make managing development, test, and live environments as seamless as ever.
Your initial Branch will be considered v1 of your business logic. Below your workspace name, you will be able to identify which Branch you are currently editing.
Select the Branch identifier located underneath the workspace name.
This will allow you to see and change which Branch you are currently editing and which is live for your users, and allow you to add a new Branch.
When you select Add new Branch you will be able to choose a source Branch to make a copy from, the name of your new Branch, set a color, and add a description.
The color you select will be reflected in different elements of the Xano UI to represent and easily inform which branch you are currently working on.
Adding a new Branch makes a copy of the source Branch at that given time. So for example, if you create v2 from source Branch v1, you will have all the same business logic (APIs, Functions, Addons, and Tasks).
The Branch you are currently editing will be identified underneath the workspace name on the left menu column and in the top banner.
To change which branch you are editing, click on the Branch name to open up the menu of the different Branches in your workspace.
Select a Branch you wish to edit or set live and you will have the option to do so.
When a Branch is set live, it is the Branch or version of your API endpoints and business logic that will be live for your users.
If you wish to call an API endpoint from a Branch that is not live, you can do so by adding the branch name after the canonical, for example:
If the live branch is:
You can access a different branch by adding :branch name after the canonical:
You can also use a Set Http Header function, to set the X-Branch header followed by the Branch name. For example:
Setting this on an API endpoint would force that endpoint to call the v2 Branch version of the endpoint.
While making changes in your workspace, you can differentiate if your Branch is live or not with the banner at the top of the UI all across Xano.
When editing a branch that isn't live, you will be presented with a banner such as the one below.
When editing a Branch that is not live, the Swagger documentation and API Endpoint URL buttons will provide the version of that Branch and not the live Branch.
To get the URL of the live Branch either remove the :branch name after the canonical or go to the live Branch.
Comparing differences allows you to see the differences between a source branch and a destination branch. Comparing differences gives you full context into what's going to change before you decide to merge branches.
To compare branches, select Compare Branches from the branches menu.
First, select the branch to compare from. This is considered the source branch.
Next, select the destination branch to compare to. If you were to merge, this is the branch to merge into.
Comparing mode will not commit to a merge, it's an opportunity to see and compare differences between the branches. You will only merge by selecting the merge option on the branches menu.
Lastly, the difference comparison opens showing everything that could merge into the destination branch and highlighting if anything is new or has changed.
Furthermore, selecting a new or changed item allows you to see a snapshot of the item for context into exactly what the new item contains or what has changed compared to the existing item.
Changes are accompanied by a number in parentheses. This number identifies how many changes there are compared to the existing item in the destination branch.
By selecting changes next to the item, a snapshot opens showing exactly what the differences and changes are.
In the above screenshot we can see the six changes:
created_at input deleted.
name input edited.
category input edited.
value input edited.
API Request added.
Create Variable added.
You can also see a snapshot of a new item. Everything in the item will be considered as added but it's insightful context for you to understand what you may be merging into another branch.
Merging Branches allows for seamless development management of different environments. It allows you to update a destination Branch with changes and updates created from a source Branch. Merging will include changes to published objects such as APIs, Functions, Addons, and Tasks, and newly created ones.
For example, your live Branch is v1. You are editing v2, which has some new API endpoints for a new feature you are rolling out. During the development phase of v2, you had to modify an API endpoint in v1. When you're ready to merge v2 into v1, Xano will add the new API endpoints from v2 and maintain the update to the API endpoint on the destination v1 Branch.
To merge Branches open the Branches menu by selecting the Branch name under the Workspace name in the left-hand navigation bar.
Next, select Merge Branches.
After selecting Merge Branches, Xano will ask you to select the source Branch.
The Source Branch is the Branch containing the updates and modifications that you want to merge into the Destination Branch.
Next, select the Destination Branch to merge the changes from the Source Branch. You can also choose if you would like the destination branch to be backed up prior to the merge.
The Destination Branch is the Branch where the updates will be merged into.
Then, Xano will display a confirmation page with all the Workspace objects receiving updates or new items.
If there is a change you do not want to include in the merge, select the settings icon next to the Workspace object and deselect the change to remove it from the merge.
Once satisfied with all the updates included in the merge select publish to merge the Branches.
From your workspace settings, you have the option to enable triggers based on certain events.
Branch Live - Any time a branch status is set to live
Branch Merge - When a branch is merged
Branch New - When a new branch is created
From your Dashboard, access the menu from the top-right corner, and choose Triggers.
Choose 'Add Workspace Trigger' and provide the requested information. In the example below, we are creating a trigger called My Workspace Trigger that will run anytime a branch merge takes place, or a new branch is created.
Your Workspace Trigger will have three inputs defined. Inputs for triggers can not be modified.
to_branch - Information regarding the destination branch
from_branch - Information regarding the source branch
action - The action taking place
Now that your trigger is set up, you can build a function stack that will run every time one of the actions selected takes place.
If after you have merged branches, you would like to restore from a backed up branch, click on the branches option, and check the "Include Backups" checkbox. This will show you all available backups, which you can then click and edit or set live just like any other branches. Setting live the backed up branch will allow you to quickly roll back to before the merge was made.
