From f07e27528241a77cec7618e0bb4d03f1f071f94d Mon Sep 17 00:00:00 2001 From: Sergei Petrosian Date: Fri, 9 Jun 2023 14:15:30 +0200 Subject: [PATCH] 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 --- .github/pull_request_template.md | 7 +++++++ .github/workflows/commitlint.yml | 14 -------------- 2 files changed, 7 insertions(+), 14 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..dabc3e7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +Enhancement: + +Reason: + +Result: + +Issue Tracker Tickets (Jira or BZ if any): diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml index 720b954..ae3e73e 100644 --- a/.github/workflows/commitlint.yml +++ b/.github/workflows/commitlint.yml @@ -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 }}' |