ssube
/
cautious-journey
1
0
Fork 0
Code
70 Commits 152 Branches 2 Tags 2.6 MiB
TypeScript 93.1%
Makefile 5.5%
Shell 1.1%
JavaScript 0.3%
Go to file
ssube 586838360b
fix(docs): add readme, basic run targets 		2020-08-22 08:36:06 -05:00
.vscode feat(build): add vscode task to compile 2020-08-11 19:13:59 -05:00
config stub more docs, check for errors in issue sync, sort labels by priority and name 2020-08-15 09:31:28 -05:00
docs fix(docs): typo 2020-08-21 11:51:40 -05:00
scripts fix(test): cover label color selection and update 2020-08-15 16:53:33 -05:00
src fix(config): match command names and docs, cover parts of sync 2020-08-20 17:20:59 -05:00
test fix(config): match command names and docs, cover parts of sync 2020-08-20 17:20:59 -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(build): remove lingering deploy jobs 2020-08-11 19:16:26 -05:00
.npmignore feat: initial project structure from template 2020-08-11 18:12:14 -05:00
Makefile fix(docs): add checking out project 2020-08-13 18:37:09 -05:00
README.md fix(docs): add readme, basic run targets 2020-08-22 08:36:06 -05:00
package.json feat(main): seed random generator with project name 2020-08-15 16:53:33 -05:00
run.mk fix(docs): add readme, basic run targets 2020-08-22 08:36:06 -05:00
tsconfig.json feat: initial project structure from template 2020-08-11 18:12:14 -05:00
yarn.lock feat(main): seed random generator with project name 2020-08-15 16:53:33 -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

Contents

Status

Pipeline status Lines of Code Test coverage MIT license FOSSA Status

Open bug count Open issue count Closed issue count

Renovate badge Dependency status Dev dependency status Known vulnerabilities

TODO: code climate maintainability

Technical debt ratio Quality issues Language grade: JavaScript Total alerts

Releases

github release link github release version github commits since release

npm package link npm release version Typescript definitions

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

FOSSA Status