Skip to main content

Design Branch

Overview​

The Design Branch feature is part of the Multiplayer version control suite of features, which is essential for any team looking to ensure that architectural changes are managed efficiently, transparently, and collaboratively.

Design Branch​

New branch.png

Multiplayer automatically creates a “main” branch for each project. The branch you are on is indicated at the center of the top navigation bar.

If you’re looking to make simple changes to your Platform’s system architecture, which everyone in your team can see immediately, you can do that directly in the “main” branch.

However, there are situations in which you want to create a new design branch, so that your team can review and provide input on your plans, before you implement them. For example, you want to:

  • Enable parallel development or experimentation of a new feature
  • Evolve or refactor portions of your system architecture
  • Fix a bug that will affect multiple components in your system architecture

Create a Design Branch​

Switch Design Branches​

  • Open your project
  • Click on “main” in the top navigation bar. If you’re currently viewing a design branch, this is where you will see the name of the new branch
  • Clicking on the design branch name at the top will open a right-side panel with more information. Here you can also switch design branches

Rename a Design Branch​

  • Click on “main” in the top navigation bar. If you’re currently viewing a design branch, this is where you will see the name of the new branch
  • In the design branch right-side panel select your branch
  • Click on the ellipsis button “…”
  • Select “Update Design Branch”
  • Type a new design branch name

Delete a Design Branch​

  • Click on “main” in the top navigation bar. If you’re currently viewing a design branch, this is where you will see the name of the new branch
  • In the design branch right-side panel select your branch
  • Click on the ellipsis button “…”
  • Select “Delete Design Branch”
  • Confirm your action in the prompt - please note that you can’t undo or recover deleted branches.

Merge a Design Branch​

(1) You don’t need team input

  • Click the drop down arrow next to “Request a Review”
  • Select “Merge”
  • Review your changes and click “Merge”

(2) You need team input

Next Steps​

You did it! What’s next?