Code Monkey home page Code Monkey logo

techtree's Introduction

techtree

The missing GitHub Projects dependency visualizer.

Create a mermaid flowchart of dependencies between GitHub issues. This gives you a map, or tech tree, of tasks, allowing you to see a path to where you want to go.

Make the following obvious:

  • Multi-Step Paths: See a path to a goal that's many steps away.
  • Islands: See which groups of tasks are unrelated, allowing parallelization.
  • Blockers: See bottleneck tasks that block many others.
  • Shared Work: See tasks that make progress on multiple fronts simultaneously.

Requirements

Requires the GitHub CLI to fetch the data.

Usage

The visualization is only as good as the input data. Create dependencies in the following ways:

  • Use a task list in the issue. When a task links to another issue, it's treated as a dependency.
  • Include a line beginning with Depends on: #123 in the issue.

Create a script with the following, making sure to use your org name and repos.

gh issue list \
  --limit 5000 \
  --repo MyOrg/repo1 \
  --state all \
  --json assignees,body,closed,closedAt,comments,id,labels,milestone,number,projectItems,state,title,updatedAt,url \
  > local/repo1_issues.txt
gh issue list \
  --limit 5000 \
  --repo MyOrg/repo2 \
  --state all \
  --json assignees,body,closed,closedAt,comments,id,labels,milestone,number,projectItems,state,title,updatedAt,url \
  > local/repo2_issues.txt
cargo run -- map \
  --header "# [My Project](https://github.com/orgs/MyOrg/projects/1/views/1)" \
  --issues local/repo1_issues.txt \
  --issues local/repo2_issues.txt \
  | pbcopy

The diagram is now in your clipboard. Paste it into an issue, PR description, comment, or wiki page.

Green boxes are open issues, and purple boxes are closed, just like in GitHub.

Filters

To only include issues that are in a GitHub Project, use --include-project "My Project Title".

By default, only issues that have a dependency or are a dependency are included. To change this, use the --all option.

techtree's People

Contributors

jtran avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.