JulienKode / pull-request-name-linter-action

⚡️ Lint pull request name with commit lint. This is useful if you squash merge your pull requests ⚡️

Home Page:https://github.com/marketplace/actions/pull-request-linter-action

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

How to work with commitlint.config.ts (TypeScript config file)

joshuaja-tangelo opened this issue · comments

I'm getting this error when pointing to my commitlint.config.ts file. Here's my workflow file for reference. Any ideas so I don't have to go back to a js file for the commitlint config?

name: Verify pull request commit
on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - uses: actions/setup-node@v3
        with:
          node-version: 18.x
      - run: yarn install --immutable --immutable-cache --check-cache

      - name: Lint pull request title
        uses: JulienKode/pull-request-name-linter-action@v0.5.0
        with:
          configuration-path: ./commitlint.config.ts

Hi @joshuaja-tangelo

You are right, it's better to have your config file in TS

  • Which version of node and typescript and commitlint are you using ?
  • Did you have the error message ?

Currently I didn't had time since a while to upgrade this repo, we have compatibility issue with node.js 16 for this action: #226 currently and we are only compatible with version 16 of commitlint.

PR are more than welcome if you want to help on this

Hi @joshuaja-tangelo

You are right, it's better to have your config file in TS

  • Which version of node and typescript and commitlint are you using ?
  • Did you have the error message ?

Currently I didn't had time since a while to upgrade this repo, we have compatibility issue with node.js 16 for this action: #226 currently and we are only compatible with version 16 of commitlint.

PR are more than welcome if you want to help on this

Hi @JulienKode!

I am using the following versions while receiving the error.

typescript: 4.9.5
commitment: 17.6.1
node: 18

What would need to happen to update the package to commitlint version 17x? I could maybe help with a PR.

Hi @joshuaja-tangelo

Thanks for your feedback and the following informations

I see two "issue":

  • commilint version is not supported, I do not know the changes between 16 and 17, but in the past since ~11/12v it was pretty straightforward to upgrade
  • node.js version is not supported by this action yet

So we will need to upgrade this action to support theses versions 2 the one of node and the one of commitlint