cautious-journey/README.md

Cautious Journey

Label manager and state machine, for Github and Gitlab.

Features

• create, delete, and update project labels
• add and remove issue labels
• mutually-exclusive label groups
• state machine between group values
• dot graph output

Contents

• Cautious Journey
  • Features
  • Contents
  • Status
  • Releases
  • Usage
    • Running with Docker
    • Running with Yarn
    • Logging with Bunyan
    • Graphing with GraphViz
  • Build
  • License

Status

TODO: code climate maintainability

Releases

Usage

cautious-journey can be installed as a Docker image or an npm package:

> docker pull ssube/cautious-journey
> yarn global add cautious-journey

Running with Docker

$(yarn global bin)/cautious-journey --help

TODO: explain

Running with Yarn

$(yarn global bin)/cautious-journey --help

TODO: explain

Logging with Bunyan

$(yarn global bin)/cautious-journey sync-issues | $(yarn global bin)/bunyan

TODO: explain, note stderr for graph output

Graphing with GraphViz

$(yarn global bin)/cautious-journey graph-labels | dot -Tpng -o /tmp/labels.png
sensible-browser /tmp/labels.png

More details can be found in the getting started guide.

Build

cautious-journey is built with make, node, and yarn. The developer guide has steps for installing these, or you can use a container that provides them.

Node 12 or better is required, along with Yarn 1.x or better.

License