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

Always fails on dependabot PR

leemeador opened this issue · comments

Dependabot creates PRs with titles that are non-conventional-commit compliant like:

Bump some-dependency from 0.79.0 to 0.81.0

I know this is not your responsibility but I would have found it helpful to handle right from the start of using your action instead of using it and then having dependabot foul things up in its default PR titles.

Sometimes this is not a problem. According to the dependabot docs, if you merge their PR with a "squash and merge" option and then put a proper conventional commit message on the PR, it will detect that and copy that form of prefix in future PRs. I don't know the quirks of this feature.

You could add a section to the main README.md showing how to skip calling the linter action. There would be an example workflow with an 'if' in it that skips the check when the PR is from dependabot.

Some docs say that this is the condition to use in a workflow to detect when a PR is generated by dependabot.

github.actor == 'dependabot[bot]'

You could also describe how to get dependabot to add prefixes to their PR titles by adding something like this to the dependabot.yaml file:

  - package-ecosystem: "pip" # for example
    directory: "/" # ... or whatever applies
    schedule:
      interval: "weekly"
    commit-message:  # this part adds 'chore:' to the front of the PR title
      prefix: "chore"

I'm still trying that last method since we don't just merge the dependabot PRs. We use the updates to create a new PR with several sets of dependabot suggestions in it and verify that they don't break anything. Then we merge that one and dependabot figures out the changes have been made and deletes its own PRs.

I'll change this comment if I find it doesn't work right.