README.md

check-checks

This is a script to maintain the 'Checks' document.

This script does:

• update the outputs of the example inputs; the code blocks after Output: header
• update the links to the playground for the example inputs
• check the document is up-to-date

For making the implementation simple, this script does not support Windows.

Prerequisites

• Go
• Linux or macOS
• shellcheck command
• pyflakes command

Usage

go run ./scripts/check-checks [FLAGS] FILE

Check the document is up-to-date.

go run ./scripts/check-checks ./docs/checks.md

Update the document. This command directly modifies the file.

go run ./scripts/check-checks -fix ./docs/checks.md

The check is run on the CI workflow.

Format

The format of the section is:

<a id="some-id"></a>
## This is title of the check

Example input:

```yaml
# This section is referred to generate the output and the playground link
on: push
jobs:
  test:
    runs-on: linux-latest # oops
    steps:
      - run: echo hello
```

Output:

```
THIS CODE BLOCK WILL BE AUTO-GENERATED
```

[Playground](URL_WILL_BE_AUTO_GENERATED)

Explanation for the check...

Multiple examples within a section are allowed. You can show multiple examples to explain one check rule.

The example input code block must not be empty and must contain at least one error.

When you don't want to update the output by this script, put the comment as follows. This script will ignore the code block. Instead you need to write the output in the code block manually.

Output:
<!-- Skip update output -->

When you don't want to put a playground link for your example input, put the comment as follows instead of the link. This script will not generate the hash for the playground link.

<!-- Skip playground link -->