This is an automated email from the ASF dual-hosted git repository.
linguini1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 6955aeb64be ci: do not trigger Build on PR description edits
6955aeb64be is described below
commit 6955aeb64be3f79acb1707d8db96c6f6738764bb
Author: raiden00pl <[email protected]>
AuthorDate: Sat Aug 15 10:51:48 2026 +0200
ci: do not trigger Build on PR description edits
The Depends-On feature (commit e73f7f7d0e) made the Build workflow
trigger on PR description edits. A gate job checks whether the edit
changed any Depends-On declaration: if yes, the build jobs run again
with the new dependencies; on any other edit the gate skips all build
jobs.
The gate has a side effect that breaks PR check results. Skipped jobs
still register check results on the PR, and the PR checks view shows
the newest check run of each name. So after any description edit the
PR shows "skipped" for every build check instead of the pass/fail
from the real run. Re-running that newest run only repeats the skip,
so the real results never come back. This can also hide a red X from
a failed build.
Fix by not triggering Build on description edits at all: remove the
"edited" event type and the gate job.
Depends-On keeps working: dependencies are read from the description
at the start of every run against master, as before. Fetch-Source now
re-reads the description through the API instead of using the copy
stored in the event payload, so every run uses the current Depends-On
state no matter how it was triggered.
After editing a Depends-On line, retrigger CI by any of:
- pushing new or rebased commits to the PR branch
- closing and reopening the PR
- pressing "Re-run all jobs" on the existing Build run
A description edit alone no longer triggers anything, which is
exactly the behavior that corrupted the PR check results.
Update Documentation/testing/nuttx-ci.rst accordingly.
Same change as in nuttx-apps; both repos received the gate from the
same Depends-On feature.
Signed-off-by: raiden00pl <[email protected]>
Assisted-by: Claude Code
---
.github/workflows/build.yml | 95 +++++++-------------------------------
Documentation/testing/nuttx-ci.rst | 19 ++++----
2 files changed, 27 insertions(+), 87 deletions(-)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 5e0ca0b9d7f..edb36643a60 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -14,7 +14,6 @@ name: Build
on:
pull_request:
- types: [opened, synchronize, reopened, edited]
paths-ignore:
- "AUTHORS"
- "CONTRIBUTING.md"
@@ -31,93 +30,19 @@ on:
- "releases/*"
tags:
+# pull-requests read: Fetch-Source re-reads the PR description so that a
+# manual re-run picks up Depends-On lines edited after the run was created.
permissions:
contents: read
+ pull-requests: read
concurrency:
group: build-${{ github.event.pull_request.number || github.ref }}
- # Edited runs do not request cancellation of an active code build.
- # GitHub may still replace an older pending run in this concurrency group.
- cancel-in-progress: ${{ github.event.action != 'edited' }}
+ cancel-in-progress: true
jobs:
- # Gate heavy CI on dependency-changing edits.
- Changes:
- runs-on: ubuntu-latest
- outputs:
- should_build: ${{ steps.gate.outputs.should_build }}
- steps:
- # Do not let PR code control its own edit gate.
- - name: Checkout base-branch CI scripts
- if: ${{ github.event_name == 'pull_request' && github.event.action ==
'edited' }}
- uses: actions/checkout@v7
- with:
- ref: ${{ github.event.pull_request.base.sha }}
- sparse-checkout: .github/scripts
- sparse-checkout-cone-mode: false
- fetch-depth: 1
- path: base-ci
- continue-on-error: true
- - name: Checkout PR CI scripts (fallback)
- if: ${{ github.event_name == 'pull_request' && github.event.action ==
'edited' }}
- uses: actions/checkout@v7
- with:
- sparse-checkout: .github/scripts
- sparse-checkout-cone-mode: false
- fetch-depth: 1
- path: pr-ci
- - name: Decide whether to run CI
- id: gate
- shell: bash
- env:
- ACTION: ${{ github.event.action }}
- NEW_BODY: ${{ github.event.pull_request.body }}
- OLD_BODY: ${{ github.event.changes.body.from }}
- BODY_CHANGE: ${{ toJSON(github.event.changes.body) }}
- BASE_CHANGE: ${{ toJSON(github.event.changes.base) }}
- run: |
- set -euo pipefail
-
- if [ "${ACTION:-}" != "edited" ]; then
- echo "Event '${ACTION:-push}': running CI."
- echo "should_build=true" >> "$GITHUB_OUTPUT"
- exit 0
- fi
-
- if [ "$BASE_CHANGE" != "null" ]; then
- echo "::notice::PR base branch changed; running CI."
- echo "should_build=true" >> "$GITHUB_OUTPUT"
- exit 0
- fi
- if [ "$BODY_CHANGE" = "null" ]; then
- echo "::notice::PR edited but body unchanged; no code/dependency
change, skipping CI."
- echo "should_build=false" >> "$GITHUB_OUTPUT"
- exit 0
- fi
-
- PARSER="pr-ci/.github/scripts/depends_on.py"
- if [ -f "base-ci/.github/scripts/depends_on.py" ]; then
- PARSER="base-ci/.github/scripts/depends_on.py"
- echo "Using base-branch parser for the gate."
- else
- echo "::notice::Base branch has no depends_on.py yet; using PR
parser for the gate (bootstrap)."
- fi
-
- # Include status so invalid declarations also retrigger reporting.
- NEW_STATE="$(PR_BODY="$NEW_BODY" python3 "$PARSER" --print-state)"
- OLD_STATE="$(PR_BODY="$OLD_BODY" python3 "$PARSER" --print-state)"
- if [ "$NEW_STATE" != "$OLD_STATE" ]; then
- echo "depends-on state changed; running CI."
- echo "should_build=true" >> "$GITHUB_OUTPUT"
- else
- echo "::notice::No depends-on change on this edit; no code change,
skipping CI."
- echo "should_build=false" >> "$GITHUB_OUTPUT"
- fi
-
# Fetch the source from nuttx and nuttx-apps repos
Fetch-Source:
- needs: Changes
- if: ${{ needs.Changes.outputs.should_build == 'true' }}
runs-on: ubuntu-latest
steps:
- name: Checkout CI scripts
@@ -130,6 +55,7 @@ jobs:
id: gittargets
shell: bash
env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_BODY: ${{ github.event.pull_request.body }}
PR_NUMBER: ${{ github.event.pull_request.number }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
@@ -138,6 +64,17 @@ jobs:
OS_REF=""
APPS_REF=""
+ # The event payload keeps the PR description from when the run was
+ # created; re-read it so a manual re-run picks up an edited
+ # Depends-On line. Keep the payload copy if the API call fails.
+ if [ -n "${PR_NUMBER:-}" ]; then
+ if LIVE_BODY="$(gh api
"repos/${GITHUB_REPOSITORY}/pulls/${PR_NUMBER}" --jq '.body // ""')"; then
+ PR_BODY="$LIVE_BODY"
+ else
+ echo "::warning::Could not re-read the PR description; using the
copy from the event payload."
+ fi
+ fi
+
REF=$GITHUB_REF
# If a base ref is set this is a PR and we will want to use
diff --git a/Documentation/testing/nuttx-ci.rst
b/Documentation/testing/nuttx-ci.rst
index cbfcb76d25f..482c7c68f8c 100644
--- a/Documentation/testing/nuttx-ci.rst
+++ b/Documentation/testing/nuttx-ci.rst
@@ -169,14 +169,17 @@ posting the report safe, but do not independently attest
that the dependency
was applied; the comment reflects the result produced by the read-only Build
workflow.
-Editing the pull request description triggers the CI dependency gate. The
-resource-intensive build jobs run again when the base branch or ordered parsed
-dependency state changes, so reordering dependencies also triggers a build.
-Unrelated description edits run only the gate and do not request cancellation
-of an already-running Build. GitHub may still replace an older pending run in
-the same concurrency group. Updating a dependency pull request does not
-automatically trigger the initiating pull request, so its CI must be rerun to
-test the new dependency head.
+Editing the pull request description does not trigger CI. Every Build run
+reads the current description when it starts. After changing a
+``Depends-On:`` declaration, retrigger CI in one of these ways:
+
+* push new or rebased commits to the pull request branch
+* close and reopen the pull request
+* press "Re-run all jobs" on the existing Build run
+
+Updating a dependency pull request does not automatically trigger the
+initiating pull request either, so its CI must be rerun to test the new
+dependency head.
The combined result belongs to the initiating pull request. It does not set a
status on dependency pull requests, merge them automatically, or replace the
