stories is a cli client for pivotal tracker for all the story delivery people out there.
drop a stories.json file in your project, and voila, you can quickly see your work, start stories, and generate summaries of recent work done.
some commands it offers:
# equivalent to tracker's "My work" tab
stories mine
# checks out a branch for a story, and marks it as started
stories branch 12345
# print a story to stdout, based on the git branch
stories view
# or, open the website
stories view --web
# you can pass an id instead of git branch
stories view 12345
# show a report of recent changes you've made to stories
stories activity
# show all of the commands
stories --helpHomebrew (mac):
brew install schpet/tap/storiesLinux and mac binaries also available on releases
Cargo (from source):
# in this project's dir
cargo install --path .
throw alias s=stories in your ~/.zshrc ~/.bashrc for good measure.
- get your api token at https://www.pivotaltracker.com/profile#api
- write this token into a file at ~/.config/stories/tracker_api_token.txt, e.g.
mkdir -p ~/.config/stories echo $YOUR_TRACKER_API_TOKEN > ~/.config/stories/tracker_api_token.txt
- drop a
stories.jsonfile in your project directory with a tracker project id, e.g.{ "project_id": 1234 }
Ensure that your pivotal tracker project is setup with the github integration which connects pull requests to tracker stories, and lets you deliver stories via commit messages.
Additionally, stories' pull-request command, e.g.
stories pr title --summarizeare intended to be used with github's gh cli, e.g.
gh pr create --title "$(stories pr title --summarize)" --body "$(stories pr body)" --web
# alias this for convenience:
gh alias set --shell prt "gh pr create --title \"\$(stories pr title --summarize)\" --body \"\$(stories pr body)\" --web"
you will also want to configure your repo's settings the following way:
- Allow merge commits (optionally disable this)
- Allow squash merging
- Default to pull request title and description
- Allow rebase merging (optionally disable this)
this can be done through the github repo settings page, or via gh api:
gh api repos/{owner}/{repo} --method PATCH -f allow_squash_merge=true -f allow_merge_commit=false -f allow_rebase_merge=false -f squash_merge_commit_title=PR_TITLE -f squash_merge_commit_message=PR_BODYcargo release -x patch
cargo release -x minor
cargo release -x major
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent