ci: Add pull request template and run commitlint on PR title only

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

Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
This commit is contained in:
Sergei Petrosian 2023-06-09 14:15:30 +02:00 committed by Richard Megginson
parent 391617cc5c
commit f07e275282
2 changed files with 7 additions and 14 deletions

7
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,7 @@
Enhancement:
Reason:
Result:
Issue Tracker Tickets (Jira or BZ if any):

View file

@ -24,20 +24,6 @@ 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
run: >-
npx commitlint --from '${{ github.event.pull_request.base.sha }}'
--to '${{ github.event.pull_request.head.sha }}' --verbose
- name: Run commitlint on PR title
run: >-
echo '${{ github.event.pull_request.title }}' |