dreampulse / action-lint-pull-request-title

Github action for linting pull request titles

action-lint-pull-request-title

This is a Github Action that ensures that your PR title matches the Commitlint Spec according to the configuration file.

This is helpful when using the "Squash and merge" strategy, Github will suggest to use the PR title as the commit message. With this action you can validate that the PR title will lead to a correct commit message.

Validation

Examples for valid PR titles:

• fix(some-scope): correct typo.
• feat(scope): add support for Node 12.

The commit config

This actions uses the following commitlint configuration

{
  "body-leading-blank": [1, "always"],
  "body-max-line-length": [2, "always", 100],
  "footer-leading-blank": [1, "always"],
  "footer-max-line-length": [2, "always", 100],
  "header-max-length": [2, "always", 100],
  "scope-empty": [2, "never"],
  "scope-case": [2, "always", "lower-case"],
  "subject-case": [2, "never", ["sentence-case", "start-case", "pascal-case", "upper-case"]],
  "subject-empty": [2, "never"],
  "subject-full-stop": [2, "never", "."],
  "type-case": [2, "always", "lower-case"],
  "type-empty": [2, "never"],
  "type-enum": [
    2,
    "always",
    ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test"]
  ]
}

You can adjust the commitlint.config.js if required.

Example github action config in your project

name: "Lint PR Title"
on:
  pull_request_target:
    types:
      - opened
      - edited
      - synchronize

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - uses: dreampulse/action-lint-pull-request-title@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

action-lint-pull-request-title's Issues

Is this project unmaintained?

The GH Action does not work as it should anymore! There are quite a few inherent issues with it, hence we are wondering if there any plans to fix, maintain and/or publish future updates for this project?

Optionally lint Title + Body

Thanks for making this useful action!

For squash and merge with one commit, Github uses title + description as commit message. Since commitlint also has restrictions on the body it'd be good to lint that too.

it seems it would just be a simple append in your current script but let me know what you think!