Skip to main content
Version: 5.3.0 - 5.3.2

Manage branches

Git branch management in KAIZEN is essential for maintaining an organised and efficient workflow. By creating separate branches for UI changes, such as theme updates, new features, or bug fixes, developers can isolate modifications, avoid conflicts, and ensure smooth collaboration across teams. This approach supports parallel development, minimises disruption to the main codebase, and allows for better testing and integration of updates, which will enhance project quality and stability.

In KAIZEN, you can perform the following branch management actions:

  • Create new branches to work on features or bug fixes in isolation without affecting the main codebase.
  • Switch branches to change the current working branch to a different one.
  • Merge branches to integrate changes from a feature branch into another branch.
  • Deactivate branches or reactivate the inactive branches based on your project requirements.
caution

Pushing generated code to target applications that do not have a matching branch is disabled. Make sure you are on the correct active branch before pushing code.

Create a new branch​

Creating a new branch allows you to work on feature enhancements or bug fixes without affecting the stable main codebase that other team members may rely on.

At the frontend​

To create a new branch, perform the following:

  1. In App Designer, click the Git icon Components Library icon on the left to open the Git panel.

  2. Click the + sign next to the branch list, then click New Branch.

    New Branch
  3. In the pop-up window, enter the following details:

    • Branch Name: Select the branch from the dropdown.

    • Revision Basis: Select Latest Revision to create the branch from the most recent version, or Latest Published Revision to create from the last officially published version.

    Create Branch window
  4. Click Save. The new branch will be created.

note

If a branch with the same name already exists, KAIZEN will flag the branch has been created. You need to enter another name.

At the backend​

To create a new branch, perform the following:

  1. In Service Designer, click the Git icon Components Library icon on your service.

  2. On the right, click the + sign next to the branch list for a new branch.

    New Branch
  3. In the pop-up window, enter the following details:

    • Branch Name: A descriptive name for the branch (e.g., dev).
  4. Click Save. The new branch will be created.

Switch branches​

important

Switching branches in KAIZEN is a personal setting and is tied to individual users. If another project member switches branches, it will not be reflected on your application.

At the frontend​

To switch the branch, you can use either the App Designer or the Studio Console.

From App Designer:

  1. Click the Resources icon on the top left. The Resources panel opens.

  2. In the bottom left corner, select the new branch and click Switch.

    Switch branch in App Designer

From Studio Console:

  1. In KAIZEN studio console, click the branch at the bottom right of your application.

  2. Select the branch from the dropdown and click Switch.

    Switch branch in Studio Console

At the backend​

To switch the branch, perform the following:

  1. In Service Designer, click Switch branch on the toolbar.

    Switch branch in Service Designer
  2. Select the branch from the dropdown for each service and click Apply.

Merge branches​

Merging a completed feature branch back into the main branch integrates the new feature's code into the main codebase, making it part of the official project.

At the frontend​

In App Designer, merging a branch includes application properties such as the app name, type, logo, favicon, micro application selections, and navigator configuration.

caution

Before merging, make sure the following conditions are met in the target branch, otherwise the merge will be blocked with an error:

  • All user domains referenced in the source branch must exist in the target branch.
  • All micro applications referenced in the source branch must exist in the target branch.
note

Theme changes are excluded from the merge diff for Main App and mobile app types.

To merge a branch in App Designer, perform the following:

  1. Switch to the target branch: In App Designer, switch to the branch you want to merge into (e.g., main).

  2. Open the merge window: On the application card, click the three-dot icon and select Merge.

  3. Select the source branch: In the merge window, select the feature branch that contains the changes to merge.

  4. Review changes: KAIZEN displays a visual comparison of the changes across pages, assets, and application properties. Click the arrows to accept the changes to bring into the target branch.

  5. Confirm the merge: After reviewing the differences and accepting the changes, click Merge to complete the process.

At the backend​

To merge a branch in Service Designer, perform the following:

  1. Switch to the target branch: In Service Designer, switch the view to the branch to merge into (e.g., main).

    Switch branch in Service Designer
  2. Open the merge window: Select the service and click the Merge icon.

    Merge branch in Service Designer
  3. Select the source branch: On the right, select the feature branch that contains the changes to merge (e.g., enhancement).

  4. Review and accept changes: KAIZEN will display a visual comparison of the changes.

    • Green indicates new additions.
    • Red indicates changes to existing lines in the code.

    Click the blue arrows to accept the changes to bring into the target branch.

    Merge into main
  5. Confirm the merge: After reviewing the differences and accepting the changes, click the final Merge button to complete the process.

Deactivate or activate a service​

In Service Designer, you can deactivate services that are no longer in use and reactivate them when needed. Deactivating unused services helps maintain a clean workspace and ensures developers focus on active services.

Deactivate a service​

To deactivate a service, perform the following:

  1. In Service Designer, select the service you want to deactivate, then click the Deactivate service button on the service toolbar.

    Deactivate service button
  2. A pop-up window appears, asking for confirmation. The window displays the name of the service being deactivated. Click OK.

    A success message will confirm that the service has been deactivated. The service will no longer appear in the active services list.

Activate a service​

To reactivate an inactive service, perform the following:

  1. In Service Designer, click Show Inactive Services & Datasources on the toolbar to display deactivated services and datasources.

    Show Inactive Services & Datasources button

    The deactivated service appears in the list in a greyed-out style.

  2. Click Activate service on the deactivated service.

    Activate service button
  3. A pop-up window appears, asking for confirmation. Click OK.

    A success message will confirm the service has been reactivated.

Last updated on 21 Sep 2026