Skip to content

emmabeynon/github-pivotal-poster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub-Pivotal-Poster

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 Pivotal Tracker story in the Pull Request, it posts a link to that Pull Request in a note to the story it finds. This is an extension to the GitHub-Trello-Poster

User Stories

As a Digital Marketplace developer

So that I can make sure that the Pivotal Tracker story 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.

Technical Documentation

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

Setting up the app

  1. Clone the repo down to your local machine.
  2. Run bundle install.
  3. Get your GitHub access token and assign to the GITHUB_ACCESS_TOKEN environment variable.
  4. Assign your Pivotal Tracker Username to the PIVOTAL_USERNAME environment variable.
  5. Retrieve your API token from your Pivotal Tracker account settings and assign it to the PIVOTAL_API_TOKEN environment variable.
  6. To set up a Webhook:
  • Navigate to your chosen organisation or repository's settings on GitHub. Select 'Webhooks' and click 'Add webhook'
  • Paste your payload URL (i.e. 'https://[insert-your-site-here]/payload') in the Payload URL box.
  • Select content type as application/json.
  • Select 'Let me select individual events' and check the 'Pull requests' box.
  • Leave the Active checkbox checked, and save.
  1. Deploy to your preferred platform, or to run locally, run ruby app.rb. If running locally, I would recommend using ngrok to create a secure tunnel from the webhook payload to your localhost.

Running the test suite

Run bundle exec rspec.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages