Setting up VCS Event Handlers in Clubhouse

With the Clubhouse VCS integrations, you can move your stories across the Clubhouse board while staying in your regular VCS workflow.

Screen_Recording_2020-07-17_at_08.45.26.69_AM.gif

After configuring your organization's VCS integration, navigate to Integrations > VCS of choice and over to the Event Handlers section. 

  1. Select "Add New Event Handler". 
  2. Select the VCS event you would like to listen for. We currently support "Pull request opened" and "Branch merged" events.
  3. Enter the name of the branch where this event will occur. Examples we use are "development", "product", or "trunk", but you may be using a multi-branch development workflow.
  4. Select the workflow state you would like the linked story to move to. 
  5. Click "Add New Event Handler" again to save. 

Your stories will now automatically update as you follow your development workflow, and merge events will affect commits as well as pull requests.

Pending work and our Event Handlers

Our integration can detect “open work” that’s associated with a Story when determining when to execute our “PR Opened” or “Branch Merged” event handler. If any open work exists, then the handler is not invoked. 

What constitutes “open work”? 

  1. Another open Pull Request being associated with the Story other than the PR that is triggering the event. If you have multiple PRs associated with a Story, taking action with just one of them will not move the Story forward.
  2. A non-deleted, non-merged Branch other than the branch that led us to the Story from the event (this could be a branch that we found via the tree of merges (in which case it would be merged already) on a push event or the branch for a PR from a PR event.