How to use the TerminusDB and TerminusCMS collaboration features using the TerminusCMS dashboard
How to branch projects using the TerminusCMS dashboard
The TerminusCMS dashboard enables you to branch projects. To do this, choose the team and project you want to branch. You will be directed to the project home page. This is where you can branch it.
Scroll down to see the manage branch
section.
Each project can have one or more branches, the default is called main. Each branch contains a snapshot of the data as it was at the time of branching. This is useful for experimenting or providing data to other teams when you want to keep them away from main.
Click the new branch
button.
Give the branch and ID.
You then have two choices:
Branch from the current head to include all of the data
Create an empty branch
Click new branch
to create it.
You will then be switched to that branch.
From the manage branch section use the ellipsis symbol next to the branches to switch between branches and main.
Reset to a particular commit of a branch using the TerminusCMS dashboard.
To reset a branch of a database, or indeed main, navigate to the project home page, the first icon on the left that looks like a database.
Scroll down to the Manage Branches
section and selected Branches
.
Next to the branch you want to reset, select the ellipses symbol to see the branch options.
Choose the Reset
button.
Choose the commit you would like to reset to and copy the commit ID by selecting the clipboard icon. You can inspect commits using the time travel feature.
Paste the commit ID and press the Reset Branch
button.
How to Clone a Project using the TerminusCMS Dashboard
From the project home page, on the right, you will see the Clone Project
section.
You can clone the project with -
The same name to another team - choose this from the dropdown menu
A different name to another team
A different name to the same team
Press the Clone
button.
You will be directed to the cloned project. If you clone to a different team, you will also move teams.
quash the commits of a branch or main into one large commit using the TerminusCMS dashboard.
To squash a branch of a database, or indeed main, navigate to the project home page, the first icon on the left that looks like a database.
Scroll down to the Manage Branches
section and selected Branches
.
Next to the branch you want to squash, select the ellipses symbol to see the branch options.
Choose the Squash
button.
Give the operation a description and press the Squash Branch
button.
Be wary as squashing a project will result in the commit history being lost
Time travel to any previous commit using the TerminusCMS dashboard
It is possible in the TerminusCMS dashboard to time travel to any previous commit and examine the data and schema. This is particularly useful if you want to see what something looked like at a particular date, or if something has broken and you want to see when the last stable state was so you can revert back to it.
Time travel is each to do. From any screen when viewing a project (apart from the project home page), you will see a stopwatch symbol
in the top bar.
Select this and a panel will appear from the right.
Each commit in the list features the comments from the merged change request.
Travel back in time by selecting the button next to the commit you want to go back to.
The dashboard informs you that you are not on the latest version.
You can then go an inspect the data in your project and the schema to see what's changed.