https://github.com/xogroup/pivotal-status-check
An app that handles responding to Github's Status API with the current state of the reflected Pivotal Story within a Pull Request
https://github.com/xogroup/pivotal-status-check
acceptance-testing criteria github pivotal pivotal-tracker pivotaltracker pull-request pull-requests story webhook webhooks
Last synced: about 2 months ago
JSON representation
An app that handles responding to Github's Status API with the current state of the reflected Pivotal Story within a Pull Request
- Host: GitHub
- URL: https://github.com/xogroup/pivotal-status-check
- Owner: xogroup
- Created: 2017-02-17T22:43:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-11T05:12:41.000Z (almost 7 years ago)
- Last Synced: 2025-07-09T07:50:44.607Z (3 months ago)
- Topics: acceptance-testing, criteria, github, pivotal, pivotal-tracker, pivotaltracker, pull-request, pull-requests, story, webhook, webhooks
- Language: Ruby
- Homepage:
- Size: 57.6 KB
- Stars: 2
- Watchers: 6
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pivotal Status Check
[](https://circleci.com/gh/xogroup/pivotal-status-check/tree/master) [](https://snyk.io/test/github/xogroup/pivotal-status-check)
This app is intended to let you have your acceptance state in Pivotal Tracker be reflected as a status check within your pull requests.
It hooks into a Github webhook which communicates with it when a pull request has been created or updated. This app then checks the status of the pivotal story related to it. If the story has been accepted, it'll return as a **success** to Github.
## Workflow That This Supports
Our pull requests get merged into Master (and deployed to Production) once they **fulfilled** the criteria below.. You are not allowed to merge to master unless these criteria are met:
* **2** peer reviews
* CI Tests pass
* Pivotal Story accepted
## Usage:
1. Pull down docker image: [Dockerhub](https://hub.docker.com/r/justneph/pivotal-status-check/)
1. Set up your deployment environment (```eb create```, etc)
1. Run the release command related to that application deployment environment
1. Setup your environment with these environment variables (see ```.env.default```)
* Github Token [**GITHUB_ACCESS_TOKEN**]
* Github Org/Repository [**GITHUB_REPO**]
* Pivotal API Token [**PIVOTAL_TRACKER_TOKEN**]
* Pivotal Project ID [**PIVOTAL_PROJECT_ID**]
* **For Github Enterprise Support:**
* Github Enterprise API URL (*eg: yourdomain.com/api/v3*) [**GITHUB_ENTERPRISE_API**]
1. Set up your [webhook](https://developer.github.com/webhooks/) on your Github repository
* Payload URL:
* **YOUR_APPLICATION_URL/accepted_status_check**
* ***Let me select individual events.***
* Choose the following events:
* Pull request
1. Set up your [webhook](https://www.pivotaltracker.com/help/articles/activity_webhook/) on your Pivotal Project
* **YOUR_APPLICATION_URL/accepted**
1. Github branch format with Pivotal Story ID at the end (snakecase) (*eg:* ```some_feature_PIVOTAL_STORY_ID``` )
1. Profit
### Note
Pivotal Projects are associated with Github Repositories so you will need to deploy a **NEW** instance for EACH **Pivotal Project ID** for EACH **Github Repository**.
## Deployment
***Out of Box Supported Deployment Environments:***
* [AWS ElasticBeanstalk](https://aws.amazon.com/elasticbeanstalk/)
* ```make eb_release```
* [Heroku](http://www.heroku.com)
* ```make heroku_release```
If you want to deploy your version of the app, simply call the above make command.
## Development
Make changes and run ```make test```
## Gotchas
* If you receive a 404 ensure that the token you're using has access to the repository, the status check is running on