Name: github-agile-dashboard
Owner: Elao
Description: ? Github Agile Dashboard
Created: 2017-06-02 21:08:21.0
Updated: 2017-11-20 12:33:41.0
Pushed: 2018-01-04 13:32:13.0
Homepage: null
Size: 427
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
npm install -g @elao/github-agile-dashboard
As recommended by GitHub, Gad relies on github.user
and github.token
variables in your git config to authenticate you on GitHub API. Follow these three steps and you're good to go:
Set up your GitHub username in your git config:
git config --global github.user "Tom32i"
Generate a GitHub personal access token with the following access rights: repo
and user
.
Set up your GitHub token in your git config:
git config --global github.token MyGitHubPersonalAccessToken
[x]
in the issue title, for example: “Add a user login [3]“.In your projet repository, just enter gad [command] (options)
.
| Command | Description | Options |
|—|—|—|
| sprint | Show the state of the current sprint | sprint -s=-1
Show the previous sprint |
| sprints | Show the state of all sprints | limit -l=2
limit the number of sprint to display |
| backlog | Show the state of the backlog | |
| review | Display PullRequest that are awaiting your review | |
| changelog | Generate a markdown changelog of the current sprint | all --all
include open issues in the changelog. sprint -s=-2
Show the changelog from two sprints ago |
| estimate | Show stories that are missing estimation | |
| sum | Calculate the sum of the stories matching the given filters | label --label=API
include issues with label “API” |
| status | Show the status of the repository | |
| help | Show list of commands | |
| exit | Quit the dashboard | |
You can manually specify any of the options on the fly:
gad -o [organisation|owner] -r [repo] -u [username] -p [password|token]
E.g.: gad -o Elao -r symfony-standard -u Tom32i -p MyGitHubPersonalAccessToken
For performance purpose, Gad keeps a little cache file for each repository.
By default, it's located in ~/.gad/cache
but you can specify a different path with the cacheDir
option:
gad -c ./cache
git clone git@github.com:Elao/github-agile-dashboard.git
cd github-agile-dashboard
npm install
node gad.js -o [organisation|owner] -r [repo] -u [username] -p [password|token]
npm run lint
npm publish --access public