danger-clubhouse
A pull request plugin to danger.systems that links to stories from Clubhouse to GitHub.
Why?
Clubhouse currently only supports one-way linking from Clubhouse to GitHub. As part of our GitHub workflow, we need to link to stories in Clubhouse so that reviewer will have more context about the pull request.
This danger plugin does exactly that :)
How?
This plugin will search for the pattern chXXXX
, where XXXX
is the story id
to Clubhouse, and links all story ids as a separated message in the format of
https://app.clubhouse.io/#{organization}/story/#{id}
.
It searches for the patterns in:
- branch name
- commit messages
- pull request comments
- pull request description
Example
Installation
Add danger-clubhouse
to your Gemfile.
gem 'danger-clubhouse'
Usage
clubhouse.organization
Set the orgazination name for Clubhouse.
clubhouse.organization = 'organization'
clubhouse.link_stories!
Find the story ids and add the story links using the Danger markdown
methods.
clubhouse.link_stories!
Thanks
- Plugin example by dblock from the danger changelog plugin.
Contact
You can find me at siong.com.
Copyright
Copyright (c) Teng Siong Ong, 2016
MIT License, see LICENSE for details.