How to use it in Github Actions?

[provokateurin]

Hi, I'm trying to use commitlint in Github Actions to validate commit messages in the CI. For some reason I can't get it to fail when it should. The current workflow is at nextcloud/neon@a32ce68. I was able to get it working locally with https://github.com/nektos/act when using --from=main --to=@, but that also didn't work on Github Actions. Can someone help me get this working? I'm not sure if the workflow is the problem or if there is a bug in this tool.

[hyiso]

You can see the configuration in this repo https://github.com/hyiso/commitlint/blob/main/.github/workflows/pr_title.yml

[provokateurin]

That only validates the PR title but I can't get it working with the commit range of the PR

[hyiso]

I've added a Github Action in this repo and created a PR to test it #8.

From The Action Running Log, the problem happened during getting commit messages in Github Action Runner, which seems to be not related to this package:

commitlint:read - from = main, to = feature/validate-pr-commit, edit = null
commitlint:read - git log --format=%B main..feature/validate-pr-commit
commitlint:read - stdout = 
commitlint:read - stderr = fatal: ambiguous argument 'main..feature/validate-pr-commit': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

[provokateurin]

Thanks for the investigation. Can we still try to fix it here? I already tried things like fetching the whole repo or pulling the main branch etc.

[provokateurin]

Can you try

      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

[hyiso]

After several tries, the following configuration works finally:

uses: actions/checkout@v3
        with:
          fetch-depth: 0
          ref: ${{ github.head_ref }}
...
dart run commitlint_cli --from="origin/${{ github.base_ref }}" --to="${{ github.head_ref }}"

You can see the log https://github.com/hyiso/commitlint/actions/runs/5560955537/jobs/10158300171?pr=8

The important parts are checkout with ref and --from with origin/ prefix

[provokateurin]

Thanks a lot! I'll try it out on my repo. I think ref: ${{ github.head_ref }} is not necessary for this to work.

[provokateurin]

Ok I was wrong, you need to set ref. It works in my repo too! Maybe you can also add an example to show how to set it up.

[provokateurin]

It works, but if someone creates a PR from a fork then it doesn't work because the branch can't be found :/

[provokateurin]

❤️