https://github.com/ericclemmons/sync-github-pivotal
Bi-directional syncing between Pivotal Tracker & GitHub Issues
https://github.com/ericclemmons/sync-github-pivotal
Last synced: about 1 year ago
JSON representation
Bi-directional syncing between Pivotal Tracker & GitHub Issues
- Host: GitHub
- URL: https://github.com/ericclemmons/sync-github-pivotal
- Owner: ericclemmons
- Created: 2020-01-29T21:26:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:38:46.000Z (over 3 years ago)
- Last Synced: 2025-03-10T19:03:22.552Z (over 1 year ago)
- Language: TypeScript
- Size: 1.79 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sync GitHub + Pivotal Tracker
> Bi-directional syncing between Pivotal Tracker & GitHub Issues
### How it Works
**GitHub is the source of truth:**
- [x] When a New GitHub Issue is created, create a Pivotal Story with `external_id`.
- [x] When a New GitHub Milestone is created, create a Pivotal Epic.
- [x] When a GitHub Issue is assigned to a GitHub MileStone, assign Pivotal Story to Epic.
- [x] When a GitHub Milestone is updated, update Pivotal Epic.
- [x] When a GitHub Label is assigned, create & assign label in Pivotal.
- [x] Sync GitHub Issue descriptions with Pivotal Story.
### What's Missing
- Sync Pivotal back to GitHub
## Getting Started
0. Fork or Clone this project.
1. `cp .env.example .env` and [adjust accordingly](/.env.example)
1. `yarn`
1. `yarn start` will open
1. `yarn tunnel` in another terminal to create an external tunnel (e.g. ):
> Dashboard: http://localhost:4040/inspect/http
1. Add webhook to GitHub (e.g. https://github.com/ORG/REPO/settings/hooks/new) with the following permissions:
_Use your `ngrok` tunnel URL (e.g. https://••••.ngrok.io/dev/github) until you push to production._
- Issues
- Milestones
- Pull Requests
- Pull request reviews
- Pull request review comments
## Deploying
0. Create a `sync-github-pivotal` profile in `~/.aws/credentials`:
```ini
[sync-github-pivotal]
aws_access_key_id=••••••••
aws_secret_access_key=••••••••••••••••
```
1. `yarn deploy`
1. Update your webhook to https://••••.execute-api.us-east-1.amazonaws.com/prod/github