CI: add commit message style check workflow #2
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # -------------------------------------------------------------------- | |
| # | |
| # Licensed to the Apache Software Foundation (ASF) under one or more | |
| # contributor license agreements. See the NOTICE file distributed | |
| # with this work for additional information regarding copyright | |
| # ownership. The ASF licenses this file to You under the Apache | |
| # License, Version 2.0 (the "License"); you may not use this file | |
| # except in compliance with the License. You may obtain a copy of the | |
| # License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| # implied. See the License for the specific language governing | |
| # permissions and limitations under the License. | |
| # | |
| # -------------------------------------------------------------------- | |
| # Commit Message Check | |
| # -------------------------------------------------------------------- | |
| # Checks the commit messages for a pull request to ensure they follow | |
| # the project's guidelines. This is not a required check and will not | |
| # block the PR from being merged. It provides suggestions for improving | |
| # commit messages. | |
| # | |
| # The main checks include: | |
| # * Title length (recommended: 50 characters or less) | |
| # * Title capitalization (should start with an uppercase letter) | |
| # * Body presence (should not be empty) | |
| # * Body line length (recommended: 72 characters or less) | |
| # -------------------------------------------------------------------- | |
| name: Commit Message Check | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened, edited] | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| check-commit-message: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check commit messages | |
| shell: bash | |
| run: | | |
| PR_COMMITS=$(git log --format="%H" ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}) | |
| echo "## Commit Message Style Check" >> $GITHUB_STEP_SUMMARY | |
| echo "Non-mandatory suggestions for reference only" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| HAS_ISSUES=false | |
| for COMMIT in $PR_COMMITS; do | |
| TITLE=$(git log --format="%s" -n 1 $COMMIT) | |
| BODY=$(git log --format="%b" -n 1 $COMMIT) | |
| RAW=$(git log --format="%B" -n 1 $COMMIT) | |
| echo "### Checking commit: ${COMMIT:0:8}" >> $GITHUB_STEP_SUMMARY | |
| echo '```' >> $GITHUB_STEP_SUMMARY | |
| echo "$RAW" >> $GITHUB_STEP_SUMMARY | |
| echo '```' >> $GITHUB_STEP_SUMMARY | |
| ISSUES=() | |
| # Check title length and capitalization | |
| if [[ ${#TITLE} -gt 50 ]]; then | |
| ISSUES+=("- Title length is ${#TITLE} characters (recommended: 50 or less)") | |
| fi | |
| if [[ ! $TITLE =~ ^[A-Z] ]]; then | |
| ISSUES+=("- Title should start with an uppercase letter") | |
| fi | |
| # Check body is not empty | |
| if [[ -z "$BODY" || "$BODY" =~ ^[[:space:]]*$ ]]; then | |
| ISSUES+=("- Commit body should not be empty") | |
| fi | |
| # Check body line length | |
| if [[ -n "$BODY" ]]; then | |
| LONG_LINES=0 | |
| while IFS= read -r line; do | |
| if [[ ${#line} -gt 72 && -n "$line" ]]; then | |
| ((LONG_LINES++)) | |
| fi | |
| done <<< "$BODY" | |
| if [[ $LONG_LINES -gt 0 ]]; then | |
| ISSUES+=("- Found $LONG_LINES line(s) in body exceeding 72 characters") | |
| fi | |
| fi | |
| # Output issues | |
| if [[ ${#ISSUES[@]} -gt 0 ]]; then | |
| HAS_ISSUES=true | |
| echo "#### Suggestions:" >> $GITHUB_STEP_SUMMARY | |
| for issue in "${ISSUES[@]}"; do | |
| echo "$issue" >> $GITHUB_STEP_SUMMARY | |
| done | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| else | |
| echo "✅ Commit message follows recommended style" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| fi | |
| done | |
| if [[ "$HAS_ISSUES" == "true" ]]; then | |
| echo "### Note" >> $GITHUB_STEP_SUMMARY | |
| echo "These suggestions are for reference only and won't block PR merging. Consider using the project's .gitmessage template." >> $GITHUB_STEP_SUMMARY | |
| fi |