From 67e4da31a42bf7bc20049aa9d32c8ba912413b1e Mon Sep 17 00:00:00 2001 From: Marco Donadoni Date: Tue, 6 Aug 2024 15:18:35 +0200 Subject: [PATCH] ci(commitlint): improve checking of merge commits (#721) --- .github/workflows/ci.yml | 2 +- run-tests.sh | 27 ++++++++++++++++++++------- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 865ef2d8..917f0dcf 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,7 +33,7 @@ jobs: - name: Check commit message compliance of the pull request if: github.event_name == 'pull_request' run: | - ./run-tests.sh --check-commitlint ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} ${{ github.event.pull_request.head.sha }} ${{ github.event.pull_request.number }} + ./run-tests.sh --check-commitlint ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} ${{ github.event.pull_request.number }} lint-shellcheck: runs-on: ubuntu-24.04 diff --git a/run-tests.sh b/run-tests.sh index 50084f87..8d9bb169 100755 --- a/run-tests.sh +++ b/run-tests.sh @@ -16,15 +16,28 @@ check_commitlint () { npx commitlint --from="$from" --to="$to" found=0 while IFS= read -r line; do - if echo "$line" | grep -qP "\(\#$pr\)$"; then - true - elif echo "$line" | grep -qP "^chore\(.*\): release"; then - true - else - echo "✖ Headline does not end by '(#$pr)' PR number: $line" + commit_hash=$(echo "$line" | cut -d ' ' -f 1) + commit_title=$(echo "$line" | cut -d ' ' -f 2-) + commit_number_of_parents=$(git rev-list --parents "$commit_hash" -n1 | awk '{print NF-1}') + # (i) skip checking release commits generated by Release Please + if [ "$commit_number_of_parents" -le 1 ] && echo "$commit_title" | grep -qP "^chore\(.*\): release"; then + continue + fi + # (ii) check presence of PR number + if ! echo "$commit_title" | grep -qP "\(\#$pr\)$"; then + echo "✖ Headline does not end by '(#$pr)' PR number: $commit_title" found=1 fi - done < <(git log "$from..$to" --format="%s") + # (iii) check absence of merge commits in feature branches + if [ "$commit_number_of_parents" -gt 1 ]; then + if echo "$commit_title" | grep -qP "^chore\(.*\): merge "; then + break # skip checking maint-to-master merge commits + else + echo "✖ Merge commits are not allowed in feature branches: $commit_title" + found=1 + fi + fi + done < <(git log "$from..$to" --format="%H %s") if [ $found -gt 0 ]; then exit 1 fi