gh-downstream

A utility tool for managing GitHub Projects.

Install

The tool lives as a GitHub extension, you can install it via the GitHub CLI

gh extension install thetechcollective/gh-downstream

Usage

usage: gh downstream [-h] [-v] {adosync,report,fix} ...

A command-line tool designed to be run as a gh cli extension. It provides features
usefull when setting up and maintaining a GitHub Project board as a Kanban
Downstream board.

positional arguments:
  {adosync,report,fix}
    adosync             We will sync the content of a Azure DevOps query with issues
                        in a designated GitHub repo
    report              Get a lead time report for a project
    fix                 Infer start dates, done dates and lead times without
                        reporting

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enable verbose output

Commands

Fix

usage: gh downstream fix [-h] [-v] --org ORGANIZATION --project PROJECT_NUMBER

Infers start dates, done dates and lead times for all issues. Includes issues that
are not done.

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enable verbose output
  --org ORGANIZATION    Name of the organization owning the project
  --project PROJECT_NUMBER
                        Project number

Report

usage: gh downstream report [-h] [-v] [--fix] --org ORGANIZATION
                            --project PROJECT_NUMBER [--from-date FROM_DATE]
                            [--to-date TO_DATE] [--mermaid]

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enable verbose output
  --fix                 Infer start dates, done dates and lead times if not already
                        present on the issue
  --org ORGANIZATION    Name of the organization owning the project
  --project PROJECT_NUMBER
                        Project number
  --from-date FROM_DATE
                        Report only on issues with Done date later than - or
                        including - this date (YYYY-MM-DD)
  --to-date TO_DATE     Report only on issues with Done date earlier than - or
                        including - this date (YYYY-MM-DD)
  --mermaid             Generate a mermaid gantt chart representing the report data

Contributing

This extension is currently only open to contributions from the .tech that team at The Tech Collective.

For more info, see CONTRIBUTING.