check-log-quality-action

Checks the semantic and syntactic quality of log messages in your code!

Based on check-log-quality tool.

Usage

By using a pipeline of two actions, we can identify poorly written log messages.

Here is how the configuration looks like:

- uses: actions/checkout@v2
- uses: aiops/check-log-quality-action@main

How it works:

1. The first actions/checkout@v2 action checkouts our code from the repo
2. Our own aiops/check-log-quality-action finds poorly written log messages and creates a report
3. Done!

Here's how our workflow looks like.

Options and outputs

You can pass any options that are supported by check-log-quality tool, to do so, you can use options key:

- uses: aiops/check-log-quality-action@main
  with:
    options: '-v src/'

You can also use the output produced by this action by default. Read more about outputs.

Acknowledgements

We took a lot of inspiration from misspell-fixer-action. Thank you!