/mikado-graph

Make a mikado graph from GitHub Issues dependency information

Primary LanguageRubyMIT LicenseMIT

Generate a Mikado Graph from GitHub Issues dependencies

Use the GitHub API to extract GitHub Issues dependencies from a repository and create a Mikado Graph from that data.

Usage

  • Create a GitHub personal access token. This should be made by a member of the organization who can see private repositories.
  • Place the access token in the file $XDG_CONFIG_HOME/github.yml or ~/.github.yml:
token: 1234567890feedfacedeadbeefcafe0987654321

Alternatively, you can specify a command to run to retrieve the token from your password manager

token_cmd: pass github.com/tokens/mikado
  • Install graphviz

Mac OS X:

$ brew install graphviz
  • Bundle, and run the script:
$ bundle install --path vendor/bundler
$ bundle exec script/mikado-graph.rb ...

Usage:

  script/mikado-graph.rb <owner/repository>

Example session:

$ bundle exec script/mikado-graph.rb lronhodl/mikado-graph
# creates `graph.png` and `graph.svg` with clickable links