ssube

Go to file

bzlibby 76cd16164a fix(docs): add merging changes to workflow.md		2020-08-23 13:06:24 -05:00
.vscode	feat(build): add vscode task to compile	2020-08-11 19:13:59 -05:00
config	feat(remote): implement issue, label list methods for Gitlab	2020-08-23 09:31:14 -05:00
docs	fix(docs): add merging changes to workflow.md	2020-08-23 13:06:24 -05:00
scripts	fix(test): cover label color selection and update	2020-08-15 16:53:33 -05:00
src	feat(remote): implement issue, label update methods for gitlab, add dryrun support	2020-08-23 12:13:52 -05:00
test	lint(sync): name CRUD functions consistently	2020-08-22 12:25:19 -05:00
vendor	feat: initial project structure from template	2020-08-11 18:12:14 -05:00
.eslintignore	feat: initial project structure from template	2020-08-11 18:12:14 -05:00
.gitignore	feat: initial project structure from template	2020-08-11 18:12:14 -05:00
.gitlab-ci.yml	fix(docs): describe running, CLI options	2020-08-22 09:58:13 -05:00
.npmignore	fix(build): publish to npm central	2020-08-22 08:52:51 -05:00
Dockerfile.alpine	fix(docs): describe running, CLI options	2020-08-22 09:58:13 -05:00
Dockerfile.stretch	fix(docs): describe running, CLI options	2020-08-22 09:58:13 -05:00
LICENSE.md	add license doc	2020-08-22 08:36:42 -05:00
Makefile	fix(docs): add checking out project	2020-08-13 18:37:09 -05:00
README.md	fix(docs): add codeclimate badge	2020-08-23 12:45:01 -05:00
package.json	feat(remote): implement issue, label list methods for Gitlab	2020-08-23 09:31:14 -05:00
run.mk	fix(docs): remove references to remote option	2020-08-22 17:48:07 -05:00
tsconfig.json	feat: initial project structure from template	2020-08-11 18:12:14 -05:00
yarn.lock	feat(remote): implement issue, label list methods for Gitlab	2020-08-23 09:31:14 -05:00

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
supports Github and Gitlab

Cautious Journey

Status

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

> docker run --rm --it ssube/cautious-journey --help

Usage: cautious-journey <mode> [options]

Commands:
  index.js graph-labels   graph label state changes
  index.js sync-issues    sync issue labels
  index.js sync-projects  sync project labels

Options:
  --help         Show help                                             [boolean]
  --version      Show version number                                   [boolean]
  --config, -c                                               [string] [required]
  --dryrun, -d                                         [boolean] [default: true]
  --project, -p                                                          [array]

Docker provides a single output stream, regardless of logger configuration. When running graph-labels, turning the logger.level to warn or error will suppress log messages that could confuse dot.

Running with Yarn

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

Yarn will install a copy of the latest cautious-journey package into your $(yarn global dir) path.

Logging with Bunyan

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

Piping logs through bunyan will pretty-print the JSON records that cautious-journey emits. When running with docker, note that all program output will be combined into a single stream.

You can also use jq to format or filter messages. Logs are line-delimited JSON.

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.