Using branches
Last updated
Last updated
Please be sure of your agent type and version and pick the right documentation accordingly.
This is the documentation of the forest-express-sequelize
and forest-express-mongoose
Node.js agents that will soon reach end-of-support.
forest-express-sequelize
v9 and forest-express-mongoose
v9 are replaced by v1.
Please check your agent type and version and read on or switch to the right documentation.
As we've explained in the previous page, your Admin panel's frontend is saved on Forest Admin servers. As a result, you can't version it. But don't worry, we've got you covered with some great tools!
The notion of branch cannot be explained without first explaining what a layout is.
A layout is all the settings that define your user interface (UI). In Forest Admin, there is 1 layout per environment and per team:
A branch is a fork (i.e copy) of the layout of its origin environment. It is attached to your development environment.
The origin of a branch is either specified using the --origin
option or selected when prompted otherwise). You should choose the environment you want to make some layout changes on.
Once you've created a branch, your layout will look exactly like the layout of its origin environment.
Imagine the following situation where you have 3 environments:
This also means that any changes made to the origin of your branch will instantly reflect on your branch. For those familiar with git's rebase, this means you will never have to rebase your branch on its origin.
Using kebab-case is recommended; however, should you want to use spaces in your branch name, don't forget to surround it with quotes, like so forest branch "my branch" --origin ...
.
On your interface, you can check at all times what branch you are on and how many layout changes were made: they appear in the top banner. The X branches pushed
information is relevant for remote environments only: it shows how many branches were already pushed onto it.
Now that you've mastered branch creation and management, let's dive into the next step of the development workflow: deployment
To manipulate your layouts, you will be using .
Any layout change you make on your current branch using the will be saved on your current branch and will not affect its origin environment.
The branch my-branch
is based on the production layout. Any changes made on it are saved in your branch's layout and can later be on it.
To create a branch, you'll need to use . Make sure you've created your local development environment using the command. Then, to create a branch named my-branch
based on your production
environment, simply run:
To learn more about the branch
command, please visit .
To switch your current branch to another existing branch, check out the command.