Skip to content

Commit

Permalink
ci: Add pull request template and run commitlint on PR title only
Browse files Browse the repository at this point in the history
We now ensure the conventional commits format only on PR titles and not
on
commits to let developers keep commit messages targeted for other
developers
i.e. describe actual changes to code that users should not care about.
And PR titles, on the contrary, must be aimed at end users.

For more info, see
https://linux-system-roles.github.io/contribute.html#write-a-good-pr-title-and-description
  • Loading branch information
spetrosi authored and Jakuje committed Jun 15, 2023
1 parent 9f26414 commit 1a7d995
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Enhancement:

Reason:

Result:

Issue Tracker Tickets (Jira or BZ if any):
20 changes: 5 additions & 15 deletions .github/workflows/commitlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ on: # yamllint disable-line rule:truthy
- main
types:
- checks_requested
permissions:
contents: read
jobs:
commit-checks:
runs-on: ubuntu-latest
Expand All @@ -22,20 +24,8 @@ jobs:
- name: Install conventional-commit linter
run: npm install @commitlint/config-conventional @commitlint/cli

# Finding the commit range is not as trivial as it may seem.
#
# At this stage, git's HEAD does not refer to the latest commit in the
# PR, but rather to the merge commit inserted by the PR. So instead we
# have to get 'HEAD' from the PR event.
#
# One cannot use the number of commits
# (github.event.pull_request.commits) to find the start commit
# i.e. HEAD~N does not work, this breaks if there are merge commits.
- name: Run commitlint on commits
- name: Run commitlint on PR title
run: >-
npx commitlint --from '${{ github.event.pull_request.base.sha }}'
--to '${{ github.event.pull_request.head.sha }}' --verbose
echo '${{ github.event.pull_request.title }}' |
npx commitlint --verbose
- name: Run commitlint on PR title
run: |
echo '${{ github.event.pull_request.title }}' | npx commitlint --verbose

0 comments on commit 1a7d995

Please sign in to comment.