CLI check does not return an error code when problems are found

[Swandog]

I installed the CLI on Mac using Homebrew, then tried to run the check subcommand on my faulty file. But, despite it detecting problems, the heylogs process returned a true (0) value:

lace on 🌱 master [$] via 🐍 v3.11.5 on ☁️  (us-east-1)
❯ heylogs check CHANGELOG.md
CHANGELOG.md
  55:1  error  Missing ref link  all-h2-contain-a-version

  1 problem

lace on 🌱 master [$] via 🐍 v3.11.5 on ☁️  (us-east-1)
❯ echo $?
0

(We discovered a similar problem when using the suggested pattern in a GitHub action, i.e.

- uses: jbangdev/jbang-action@v0.110.1
  with:
    script: com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin
    scriptargs: "check CHANGELOG.md"

does not fail CI if the CHANGELOG.md does not pass the check)

It would be nice for the check command to return an error if the check fails, or if there was an option to cause that behavior (e.g., a CLI option like --exit-with-error-on-errors, but maybe less verbose/clunky)

[charphi]

You are right; the CLI should return an error code.
The error code should be -1 aka CommandLine.ExitCode.SOFTWARE

[charphi]

Done in bb364ab