2020-08-22 13:26:41 +00:00
# Cautious Journey
2020-08-30 23:42:20 +00:00
< p align = "center" >
< img align = "center" src = "docs/logo.png" >
< / p >
< p align = "center" >
Label manager and state machine, for Github and Gitlab.
< / p >
2020-08-22 13:26:41 +00:00
## Features
- create, delete, and update project labels
- add and remove issue labels
- mutually-exclusive label groups
- state machine between group values
- `dot` graph output
2020-08-23 17:22:25 +00:00
- supports Github and Gitlab
2020-08-22 13:26:41 +00:00
## Contents
- [Cautious Journey ](#cautious-journey )
- [Features ](#features )
- [Contents ](#contents )
- [Status ](#status )
- [Releases ](#releases )
- [Usage ](#usage )
- [Running with Docker ](#running-with-docker )
- [Running with Yarn ](#running-with-yarn )
- [Logging with Bunyan ](#logging-with-bunyan )
- [Graphing with GraphViz ](#graphing-with-graphviz )
- [Build ](#build )
- [License ](#license )
## Status
[](https://git.apextoaster.com/ssube/cautious-journey/commits/master)
[](https://sonarcloud.io/dashboard?id=ssube_cautious-journey)
[](https://codecov.io/gh/ssube/cautious-journey)
[](https://github.com/ssube/cautious-journey/blob/master/LICENSE.md)
[](https://github.com/ssube/cautious-journey/issues?q=is%3Aopen+is%3Aissue+label%3Atype%2Fbug)
[](https://github.com/ssube/cautious-journey/issues?q=is%3Aopen+is%3Aissue)
[](https://github.com/ssube/cautious-journey/issues?q=is%3Aissue+is%3Aclosed)
[](https://renovatebot.com)
2020-08-23 18:44:50 +00:00
[](https://libraries.io/github/ssube/cautious-journey)
2020-08-22 13:26:41 +00:00
[](https://snyk.io/test/github/ssube/cautious-journey)
2020-08-23 17:45:01 +00:00
[](https://codeclimate.com/github/ssube/cautious-journey/maintainability)
2020-08-22 13:26:41 +00:00
[](https://codeclimate.com/github/ssube/cautious-journey/trends/technical_debt)
[](https://codeclimate.com/github/ssube/cautious-journey/issues)
[](https://lgtm.com/projects/g/ssube/cautious-journey/context:javascript)
[](https://lgtm.com/projects/g/ssube/cautious-journey/alerts/)
## Releases
[](https://github.com/ssube/cautious-journey/releases)
[](https://github.com/ssube/cautious-journey/releases)
[](https://github.com/ssube/cautious-journey/compare/v0.1.0...master)
[](https://www.npmjs.com/package/cautious-journey)
[](https://www.npmjs.com/package/cautious-journey)
[](https://www.npmjs.com/package/cautious-journey)
## Usage
cautious-journey can be installed as a Docker image or an npm package:
```shell
> docker pull ssube/cautious-journey
> yarn global add cautious-journey
```
### Running with Docker
```shell
2020-08-22 14:49:52 +00:00
> 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]
2020-08-22 13:26:41 +00:00
```
2020-08-22 22:29:19 +00:00
Docker provides a single output stream, regardless of logger configuration. When running `graph-labels` , turning
2020-08-22 14:49:52 +00:00
the `logger.level` to `warn` or `error` will suppress log messages that could confuse `dot` .
2020-08-22 13:26:41 +00:00
### Running with Yarn
```shell
$(yarn global bin)/cautious-journey --help
```
2020-08-22 14:49:52 +00:00
Yarn will install a copy of the latest `cautious-journey` package into your `$(yarn global dir)` path.
2020-08-22 13:26:41 +00:00
### Logging with Bunyan
```shell
$(yarn global bin)/cautious-journey sync-issues | $(yarn global bin)/bunyan
```
2020-08-22 14:49:52 +00:00
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.
2020-08-22 13:26:41 +00:00
### Graphing with GraphViz
```shell
$(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 ](./docs/getting-started.md#graphing ).
## Build
cautious-journey is built with `make` , `node` , and `yarn` . The [developer guide ](./docs/dev.md#setup ) 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
2020-08-23 18:44:50 +00:00
Released under [the MIT license ](./LICENSE.md ).
