name: Commit Quality # pull_request_target gives fork PRs a token that can post the comments. That # is safe only while this workflow never runs PR code: the checkouts take # Tools/ci from the base branch, so never give them a ref from the PR, and pass # PR fields (title, body, branch names) to the scripts through env, never # inline in a run block. on: pull_request_target: types: [opened, edited, synchronize, reopened] permissions: contents: read pull-requests: write issues: write # github.ref is the base branch under pull_request_target, shared by every PR # against it, so group by PR number. concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number }} cancel-in-progress: true env: PR_NUMBER: ${{ github.event.pull_request.number }} jobs: pr-title: name: PR Title runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v6 with: sparse-checkout: Tools/ci fetch-depth: 1 - name: Check PR title id: check env: PR_TITLE: ${{ github.event.pull_request.title }} BASE_REF: ${{ github.event.pull_request.base.ref }} run: | python3 Tools/ci/check_pr_title.py "$PR_TITLE" --base-ref "$BASE_REF" --markdown-file comment.md && rc=0 || rc=$? echo "exit_code=$rc" >> "$GITHUB_OUTPUT" - name: Post or clear comment env: GH_TOKEN: ${{ github.token }} run: | if [ "${{ steps.check.outputs.exit_code }}" != "0" ]; then if [ ! -s comment.md ]; then echo "The PR title check failed without producing a report." > comment.md fi python3 Tools/ci/pr_comment.py --marker pr-title --pr "$PR_NUMBER" --result fail < comment.md else python3 Tools/ci/pr_comment.py --marker pr-title --pr "$PR_NUMBER" --result pass fi - name: Result if: steps.check.outputs.exit_code != '0' run: | echo "::error::PR title check failed. See the PR comment for details." exit 1 pr-body: name: PR Description runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v6 with: sparse-checkout: Tools/ci fetch-depth: 1 - name: Check PR body id: check env: PR_BODY: ${{ github.event.pull_request.body }} run: | message="" if [ -z "$PR_BODY" ]; then message="PR description is empty. Please add a summary of the changes." echo "::warning::PR description is empty." else cleaned=$(echo "$PR_BODY" | sed 's///g' | tr -d '[:space:]') if [ -z "$cleaned" ]; then message="PR description contains only template comments. Please fill in the details." echo "::warning::PR description contains only template comments." fi fi echo "message=$message" >> "$GITHUB_OUTPUT" - name: Post or clear comment env: GH_TOKEN: ${{ github.token }} run: | if [ -n "${{ steps.check.outputs.message }}" ]; then printf '%s\n' \ "## PR Description (advisory)" \ "" \ "This is **not blocking**, but your PR description appears to be empty or incomplete." \ "" \ "${{ steps.check.outputs.message }}" \ "" \ "A good PR description helps reviewers understand what changed and why." \ "" \ "---" \ "*This comment will be automatically removed once the issue is resolved.*" \ | python3 Tools/ci/pr_comment.py --marker pr-body --pr "$PR_NUMBER" --result warn else python3 Tools/ci/pr_comment.py --marker pr-body --pr "$PR_NUMBER" --result pass fi