ci: enable commitlinter with conventional rules

[artek-koltun]

please find conventional commit rules https://www.conventionalcommits.org/en/v1.0.0/

[codecov]

Codecov Report

Merging #138 (b410982) into main (f751cc6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #138   +/-   ##
=======================================
  Coverage   62.06%   62.06%           
=======================================
  Files           1        1           
  Lines          58       58           
=======================================
  Hits           36       36           
  Misses         15       15           
  Partials        7        7           

[glimchb]

@artek-koltun can we put .commitlintrc.json inside .github folder ?

[seroyer]

This is a great idea. I personally like even stricter rules than the defaults in commitlinter (like shorter headers), but I'm ok with this.

[artek-koltun]

@artek-koltun can we put .commitlintrc.json inside .github folder ?

.commitlintrc.json is a config file like .golangci.yml which resides in the root. I assume for the purpose to run it locally without specifying the path to the config explicitly. If we are not going to support a case when commitlint is run locally, then we can move it into .github...

[glimchb]

.commitlintrc.json is a config file like .golangci.yml which resides in the root.

I understand. for example renovate.json can eaither be in root or in .github folder. both locations are supported
see https://docs.renovatebot.com/configuration-options/

So I'm asking if .commitlintrc.json is supported in .github folder as well?

[artek-koltun]

I understand. for example renovate.json can eaither be in root or in .github folder. both locations are supported see https://docs.renovatebot.com/configuration-options/

So I'm asking if .commitlintrc.json is supported in .github folder as well?

Checked it and the answer is no, it is not supported. It supports different config file formats, but they should be in the root location.
Probably yml format is preferable for us for consistency, since we already have .golangci.yml in the root...

[glimchb]

Checked it and the answer is no, it is not supported. It supports different config file formats, but they should be in the root location. Probably yml format is preferable for us for consistency, since we already have .golangci.yml in the root...

thanks for checking

[glimchb]

@artek-koltun missed a problem in this PR, I fixed it here 95ce6d7

[glimchb]

@artek-koltun new problem:

The following actions uses node12 which is deprecated and will be forced to run on node16: actions/setup-node@v2.

For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default

[glimchb]

See new PR #139

[artek-koltun]

@artek-koltun missed a problem in this PR, I fixed it here 95ce6d7

if we just use

  push:
    branches: [ "main" ]

It will check all the commits from the very first one in the history and will always report fail status. But maybe with ahmadnassri/action-commit-lint it is going to be ok.

Another question if we need that check after merging PRs? Probably running it only on PRs and forbidding pushes into main is enough?

[artek-koltun]

@artek-koltun new problem:

The following actions uses node12 which is deprecated and will be forced to run on node16: actions/setup-node@v2.

For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default

Where did you see that warning? Looks like we use 20.x version...