mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 14:19:57 +08:00
* docs(contributing): discourage force-pushing during review A force-push after review has begun erases the commits a reviewer has read, so they cannot see what changed since. The guidance told contributors to squash and reword instead, which contradicts the commit and pr agent skills. PRs are typically squash-merged, so branch history does not need cleaning up before merge. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com> * ci(workflows): remove commit message check PRs are squash-merged under the PR title, which is still checked. Flagging the individual commits pushed contributors to rewrite history mid-review. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com> --------- Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com>
109 lines
3.5 KiB
YAML
109 lines
3.5 KiB
YAML
name: Commit Quality
|
|
|
|
on:
|
|
pull_request:
|
|
types: [opened, edited, synchronize, reopened]
|
|
|
|
permissions:
|
|
contents: read
|
|
pull-requests: write
|
|
issues: write
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
|
IS_FORK: ${{ github.event.pull_request.head.repo.full_name != github.repository }}
|
|
|
|
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 }}
|
|
run: |
|
|
python3 Tools/ci/check_pr_title.py "$PR_TITLE" --markdown-file comment.md && rc=0 || rc=$?
|
|
echo "exit_code=$rc" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Post or clear comment
|
|
if: env.IS_FORK == 'false'
|
|
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 does not follow conventional commits format. See the PR comment for details."
|
|
exit 1
|
|
|
|
pr-body:
|
|
name: PR Description
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
if: env.IS_FORK == 'false'
|
|
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
|
|
if: env.IS_FORK == 'false'
|
|
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
|