Skip to content

ci: scope commitlint to PR-introduced commits, fix title suffix check #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MichaelTaylor3d wants to merge 1 commit into from
Closed

ci: scope commitlint to PR-introduced commits, fix title suffix check #603

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions .github/workflows/commitlint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,20 @@ jobs:
with:
fetch-depth: 0

- name: Lint PR commits
# A main-base PR is a develop -> main release cut: every commit in main..develop
# was already linted at its own PR, while that commit was still mutable and its
# author could still fix it. Re-linting the whole inherited range at cut time adds
# no information and cannot be satisfied (the commits are now immutable, pinned by
# gitlinks and rev-pinned deps). Lint only what THIS PR introduces: its own commit(s).
- name: Lint PR commits (release cut — this PR's own commits only)
if: github.base_ref == 'main'
uses: wagoid/commitlint-github-action@v6
with:
configFile: commitlint.config.mjs
commitDepth: 1

- name: Lint PR commits (feature branch — full PR range)
if: github.base_ref != 'main'
uses: wagoid/commitlint-github-action@v6
with:
configFile: commitlint.config.mjs
Expand All @@ -37,9 +50,13 @@ jobs:
if: github.event_name == 'pull_request'
env:
PR_TITLE: ${{ github.event.pull_request.title }}
PR_NUMBER: ${{ github.event.pull_request.number }}
run: |
set -euo pipefail
# Install both @commitlint/cli AND the extended shareable config so the
# `extends: ['@commitlint/config-conventional']` in commitlint.config.mjs resolves.
echo "$PR_TITLE" | npx --yes -p @commitlint/cli -p @commitlint/config-conventional \
# GitHub's squash merge lands "$PR_TITLE (#$PR_NUMBER)" as the commit subject —
# lint that exact string, not the title alone, or a title within the length
# limit can still produce an over-limit commit subject once merged.
printf '%s (#%s)\n' "$PR_TITLE" "$PR_NUMBER" | npx --yes -p @commitlint/cli -p @commitlint/config-conventional \
commitlint --config commitlint.config.mjs
Loading