Skip to main content

Application: github-trello-poster

A handy tool that automatically posts GitHub pull request links to Trello cards.


Build Status

This app uses GitHub webhooks to be notified when a Pull Request is opened or changed on GitHub. When it finds a link to a Trello card in the Pull Request, it posts a link to that Pull Request to a checklist on the card it finds. When a Pull Request is merged or closed, the app checks the Pull Request off the checklist, even in cases where a user may have modified the item in the checklist.

User Stories

As a GOV.UK developer
So that I can make sure that the Trello card I am working on has the correct PR information
I would like a link to relevant PRs to be automatically added to the Trello card.
As a GOV.UK developer
So that I can make sure that Pull Request information on the Trello card I am working on is up to date
I would like the link to a Pull Request to be checked off after I have merged it.

Technical Documentation

This app is built using Ruby and Sinatra. It makes use of GitHub webhooks to receive pull request information, and the Trello API to post pull request information to Trello cards.

Setting up the app

  1. Run bundle install.
  2. Get your GitHub access token and assign to the GITHUB_ACCESS_TOKEN environment variable. On GOV.UK, we use a token associated with the govuk-ci user.
  3. Create a Trello account and add it to your team’s Trello board, giving read and write access. On GOV.UK, we use the @pullrequestposter user.
  4. Get your Trello developer API key and assign to the TRELLO_PUBLIC_KEY environment variable. You may also find this key using ruby-trello’s helpful methods.
  5. Get your Trello user token and assign to the TRELLO_MEMBER_TOKEN environment variable. You may also find this token using ruby-trello’s helpful methods.
  6. Deploy github-trello-poster to your preferred platform, or run locally with ruby app.rb and use ngrok to open a secure tunnel to your localhost.
  7. Set up the webhook between your repo(s) and github-trello-poster. This is done automatically by govuk-saas-config for all GOV.UK repos. To set it up manually, go into your repo settings in GitHub and create a webhook pointing to your payload URL (‘https://[insert-your-site-here]/payload’), select a content type of application/json, then finally choose ‘Let me select individual events’ and check the ‘Pull requests’ box.

Running the test suite

Run bundle exec rspec. Note the feature tests require real-world set up of Trello cards and GitHub repos, and you will need to amend the tests accordingly.