Commit 2c86367c authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: update README

parent 09a7ce92
Loading
Loading
Loading
Loading
+18 −9
Original line number Diff line number Diff line
# to-be-continuous utils
# tbc-check CLI tool

Various to-be-continuous internal utility tools.
`tbc-check` is a basic CLI program that checks to-be-continuous templates.

## template-to-component

This program helps migrating to-be-continuous legacy templates (include:project) to GitLab CI/CD components (include:component).

Usage:
## Usage

```bash
# install dependencies
poetry install

# obtain help
poetry run t2c --help
poetry run tbc-check --help

# run tool
poetry run t2c path/to/tbc/template
poetry run tbc-check path/to/tbc/template
```

## Checked rules

`tbc-check` checks the following rules:

- the existence of the `kicker.json` file
- the existence of the `README.md` file
- for each variable in the `kicker.json` file (main template and variants):
    - mapped input is declared in the related template with same name, type, default, options and description (WARNING only)
    - the variable is declared in the related template with expected input mapping (`$[[ inputs.input-name ]]`)
    - the input/variable is documented in the README (WARNING only)

If any non-WARNING rule fails, `tbc-check` fails with exit code 127.