Document how to configure GitHub action about codeowners-validator HOT 2 CLOSED

Hi @nitrocode

Thanks for reporting that. It's a problem with workflow syntax. You need to define it as action argument, not enviromnet variable, see:

name: Validate Codeowners
on:
  pull_request:

jobs:
  validate-codeowners:
    runs-on: ubuntu-latest
    steps:
    - name: "Checkout source code at current commit"
      uses: actions/checkout@v2
    - uses: mszostok/[email protected]
      with:
        checks: "syntax,owners,duppatterns"
        github_access_token: "${{ secrets.CODE_OWNER_VALIDATION }}"
        owner_checker_ignored_owners: "@user1,@user2,@user3" # you need to define them as action argument

The codeowners validator can be used directly as binary e.g. locally or on other CI system and also as GitHub Action.

When it is used as a GitHub action, the configuration needs to be specified as action arguments. This is the preferred way. You can also use the env variable but then you need to add INPUT_ prefix which GitHub adds by default, so on GitHub action OWNER_CHECKER_IGNORED_OWNERS becomes INPUT_OWNER_CHECKER_IGNORED_OWNERS.

I will update GitHub action documentation to make it clear also for others.

Cheers!

from codeowners-validator.

[NOTE] relates to: #73

from codeowners-validator.