Contentstack Management - Branches Actions

Branches offer isolated workspaces for safe, independent development of new features or updates. With branches you can create multiple copies of your stack content. You can perform branch-based operations using the following Contentstack Management Branches actions.

Note: You must have the Branches feature enabled for your stack. For more information, please reach out to our Support Team.

Let’s look at each of them in detail.

Create a Branch

This action creates a new branch in a stack.

1. Under Choose an Action tab, select the Create a Branch action.
2. On the Create a Branch Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
   2. Select a Stack and Branch from the Lookup list. The new branch will be a copy of the source branch.

      Note: By default, the main branch is selected.

   3. Provide a Branch UID. The Branch UID must be lowercase, with no spaces, and maximum 15 characters.
      
3. Once done, click Proceed.
4. Click Test Action to test the configured action.
   
5. On successful configuration, you can see the below output. Click Save and Exit.
   

Delete a Branch

This action deletes an existing branch in a stack.

1. Under Choose an Action tab, select the Delete a Branch action.
2. On the Delete a Branch Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.

   2. Select a Stack and Branch from the Lookup list. The selected branch will be deleted.
      

      
3. Once done, click Proceed.
4. Click Test Action to test the configured action.

   Warning: This deletes all the content types and assets in the selected branch.

   
5. The output will be shown as follows. Click the Save and Exit button.
   

Get All Branches

This action fetches the details of all the branches in a stack.

1. Under Choose an Action tab, select the Get All Branches action.
2. On the Get All Branches Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
   2. Select a Stack from the Lookup list.
   3. [Optional] Enable the Show Optional Fields toggle button to display the Branch Limit and Skip Branch (Pagination) fields.
      
      

3. Once done, click Proceed.
4. Click Test Action to test the configured action.
   
5. The output will be shown as follows. Click the Save and Exit button.
   

Get a Single Branch

This action fetches the details of a single branch in a stack.

1. Under Choose an Action tab, select the Get a Single Branch action.
2. On the Get a Single Branch Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
   2. Select a Stack and Branch from the Lookup list. The details of the selected branch will be fetched.
      
3. Once done, click Proceed.
4. Click Test Action to test the configured action.
   
5. The output will be shown as follows. Click the Save and Exit button.
   

Merge Branch

This action lets you merge the content types and global fields from a compare branch into the base branch.

1. Under Choose an Action tab, select the Merge Branch action.
2. On the Merge Branch Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
   2. Select a Stack, Compare Branch, and Base Branch from the Lookup list.

      The content types and global fields are copied from the Compare (source) branch into the Base (target) branch based on the Merge Strategy.

      
   3. Select a Merge Strategy to merge the branch content.

      Let’s look at each of them in detail:

      1. Merge Prefer Base: This will merge the changes from the compare branch into the base branch. In case of conflicts, it will retain the base branch changes.
      2. Merge Prefer Compare: This will merge the changes from the compare branch into the base branch. In case of conflicts, it will retain the compare branch changes.
      3. Overwrite With Compare: This will overwrite the base branch changes with compare branch changes.
      4. Merge New Only: This will only merge the new changes in the base branch.
      5. Merge Modified Only Prefer Base: This will only merge the modified changes from the compare branch into the base branch, and will keep the base branch changes in case of conflicts.
      6. Merge Modified Only Prefer Compare: This will only merge the modified changes from the compare branch into the base branch, and will keep the compare branch changes in case of conflicts.
      7. Ignore: This is a default value, which will not merge the branch content.
   4. Enter additional descriptive comment(s) for the merge action in the Merge Comment field. The specified comments can be fetched via the ‘Get a Single Merge Job’ actions for future reference.
      
3. Once done, click Proceed. 
4. Click Test Action to test the configured action.
   
5. On successful configuration, you can see the below output. Click Save and Exit button.
   

Get a Single Merge Job

This action fetches the details of a single merge job in a stack.

1. Under Choose an Action tab, select the Get a Single Merge Job action.
2. On the Get a Single Merge Job Configure Action page, enter the details given below:
   1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
   2. Select a Stack and Merge Job from the Lookup list.
      
3. Once done, click Proceed.
4. Click Test Action to test the configured action.
   
5. On successful configuration, you can see the below output. Click Save and Exit.