Mirror a pivotal tracker (PT) project to an another tracker system (only github is currently supported for now as a mirror target):
- Stories in the PT are mirrored into github issues.
- Comments in stories are mirrored into github issue comments
Mirroring a PT projet stories into github issues provides the following benefits:
leverage the watching notifications github feature to track progress on public pivotal trackers which lacks such self-service update notification featureEDIT: Pivotal tracker supports this as of March 2017, see Viewers can follow in pivotal tracker blog.- leverage github search features to search PT content (e.g. accross multiple mirrored PT projects, or along with other github repositories), including permalink URLs that return search results (e.g. for identity and refresh tokens)
- leverage github @mentions to contact github accounts associated with PT public projects contributors, in the context with a specific mirrored story
- mirrored content becomes discoverable: search engines would index it, making it easier to find mirrored PT such as a stack trace
- clone this repo and
cdto the new directory - run `mvn clean install``
- set env var (see below)
- if you have a cloud foundry instance, create a database service and add this service to the manifest.yml and do
cf pushotherwise run `java -jar ./target/pivotaltrackermirror-1.0.0.war
| Key | Default value | Description |
|---|---|---|
| admin_password | password | mirror UI login |
| admin_username | admin | mirror UI pwd |
| pivotaltracker_token | NONE | used to pull pivotal tracker data |
| refresh_mirror_after_minutes | 120 | periodicity of refreshes |
| story_filtered_labels | "CVE" | exclude some stories assigned some labels (comma-separated, case insensitive) |
This application provides an api more than a frontend. Developers or users can use this api.
Click here to see the api documentation
You can also test this api through swagger-ui, to do so, you have to deploy the app and browse to this endpoint /swagger-ui.html.
Go to url of the app deployed on cloud foundry or http://localhost:8080 for local deployments and manage mirrors through the UI:
In the "Converter token", specify a github personal access token with the repo Full control of private repositories scope. The account associated to this token needs owner permission on the target github repo, in order for the trackermirror to set up issue labels.
Then a regular job mirrors PT stories (in the non-accepted state) into GH issues.
See sample partial attempt with the mirrored into https://github.com/cf-tm-bot/buildpacks
List of mirrored stories
A sample mirrored story with comments
Note that screenshots may be out of date w.r.t. latest code improvements.
When upgrading pivotaltrackermirror (e.g. improving mapping markup), you may request to reimport all mirrored stories in the UI. There are additional REST endpoints that can provide additional details beyond what the UI displays, e.g.
curl -k -u login:pwd https://trackerapp.org/api/tasks/15
{"jobStatus":"COMPLETE","dateStartTime":"2016-08-12T13:09Z","nextFireTime":"2016-08-25T15:09Z","previousFireTime":"2016-08-25T13:09Z"}
This project originated as a POC to help the Cf community track progress of the CF pivotal tracker stories used to drive the cloudfoundry backlog and features (see full list in the sidebar).
Currently there is no way for non project members to subscribe to PT story updates, see related cf-dev thread or cloudfoundry/cli#560 (comment) where CLI team PM tried to add non-team members to provide ways to check story status), or to comment on stories.
This project is generally trying to make it easier for the cloudfoundry community to interact with cloud foundry core contributors and suggest product ideas or comment current progresses/decisions/investigations.
Feedback and contributions are welcome. See issues for current ideas of future improvement. We use milestones for tracking relative priority, have a look at https://huboard.com/orange-cloudfoundry/pivotaltrackermirror#/milestones for a visual display.