VCS Integrations

How do I associate a branch to a Story?

There are two ways to connect a branch to a Story in Clubhouse.

Format your branch name to associate to a Story

1. Use Git Helpers to format your branch name.

To create a new feature branch, click the Story you want to work with, and then click the "Git Helpers" icon located in between the Story ID number and Settings ellipsis icon.

 Screenshot_2018-12-28_12.58.19.png

Then copy the suggested branch name to create and checkout a new branch for your story. Whenever you push a branch, it will be automatically linked to the story.

2. Include the Story number in your branch name

If the format from the Git Helper doesn’t fit with your branch naming conventions, you can also associate the branch by including /ch###/ (for example /ch345/) somewhere in the branch name.

The branch name must include the Story ID in the form ch### somewhere in it. Depending on its placement in the branch, slashes can surround the Story ID or a single slash can be placed before or after. You can also name the branch with just the Story ID.

These are all valid branch name examples:

  • abbya/ch345/cool-branch
  • ch345/cool-branch
  • cool-branch/ch345
  • ch345 

Associating Branches with Stories with a Pull Request

Branches can be associated with multiple stories using pull request descriptions. Add the Story numbers to the description with the prefix `ch` in brackets.

Additional PRs to the same branch will associate to the listed Story or Stories.

While multiple Stories can be associated with a single branch, pushing to a branch with a different Story number will not disassociate it from any Story it was previously associated with.

Have more questions? Submit a request
Powered by Zendesk