Skip to content

Commit f039c78

Browse files
mario-camposCopilot
andcommitted
Warn about direct CHANGELOG.md changes in PR checks
Split workflow activation from #4217 while keeping the comment action loaded from trusted main. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 3ea37a4 commit f039c78

1 file changed

Lines changed: 73 additions & 2 deletions

File tree

‎.github/workflows/pr-checks.yml‎

Lines changed: 73 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ jobs:
9595
contents: read
9696
runs-on: ubuntu-26.04
9797
timeout-minutes: 10
98+
outputs:
99+
changelog-modified: ${{ steps.changelog-check.outputs.modified }}
98100

99101
concurrency:
100102
cancel-in-progress: ${{ github.event_name == 'pull_request' || false }}
@@ -191,6 +193,20 @@ jobs:
191193
path: ${{ runner.temp }}/repo-size/
192194
if-no-files-found: error
193195

196+
- name: Check for CHANGELOG.md changes
197+
id: changelog-check
198+
if: steps.fetch-base.outcome == 'success'
199+
env:
200+
BASE_SHA: ${{ steps.fetch-base.outputs.merge_base }}
201+
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
202+
run: |
203+
if ! git diff --exit-code --quiet "$BASE_SHA" "$HEAD_SHA" -- CHANGELOG.md; then
204+
echo "CHANGELOG.md was modified in this PR."
205+
echo "modified=true" >> "$GITHUB_OUTPUT"
206+
else
207+
echo "modified=false" >> "$GITHUB_OUTPUT"
208+
fi
209+
194210
- name: "Backport: Check out base ref"
195211
id: checkout-base
196212
if: ${{ startsWith(github.head_ref, 'backport-') }}
@@ -211,8 +227,8 @@ jobs:
211227
exit 1
212228
fi
213229
214-
post-repo-size-comment:
215-
name: Post repo size comment
230+
post-pr-comments:
231+
name: Post PR comments
216232
needs: other-checks
217233
# Keep write permissions isolated from the job that checks out and tests PR code. This job only
218234
# posts the candidate comment body produced by the read-only `pr-checks` job.
@@ -232,6 +248,22 @@ jobs:
232248
group: check-repo-size-${{ github.event.pull_request.number }}
233249

234250
steps:
251+
- name: Checkout repository
252+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
253+
with:
254+
# Check out main, not the PR's head, since this job runs with
255+
# `pull-requests: write` permissions and must not execute untrusted code from the PR.
256+
ref: main
257+
258+
- name: Set up Node.js
259+
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
260+
with:
261+
node-version: 24
262+
cache: "npm"
263+
264+
- name: Install dependencies
265+
run: npm ci --workspace=pr-checks
266+
235267
- name: Download repo size comment
236268
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
237269
with:
@@ -261,3 +293,42 @@ jobs:
261293
else
262294
echo "Skipping repo size comment because the delta is below the threshold and no sticky comment exists."
263295
fi
296+
297+
- name: Post a warning about modifying CHANGELOG.md
298+
# Release, backport, mergeback, and bundle-update PRs deliberately modify CHANGELOG.md,
299+
# so skip comment management entirely for these automation flows.
300+
if: >-
301+
needs.other-checks.outputs.changelog-modified == 'true' &&
302+
!startsWith(github.event.pull_request.head.ref, 'update-v') &&
303+
!startsWith(github.event.pull_request.head.ref, 'backport-v') &&
304+
!startsWith(github.event.pull_request.head.ref, 'mergeback/') &&
305+
!startsWith(github.event.pull_request.head.ref, 'update-bundle/')
306+
uses: ./.github/actions/post-comment
307+
with:
308+
marker: "post-comment:CHANGELOG.md"
309+
body: |
310+
⚠️ `CHANGELOG.md` has been modified in this PR. Please do not modify `CHANGELOG.md` directly.
311+
Instead, create a change-note file in `unreleased-change-notes/`. The `CHANGELOG.md`
312+
file will be automatically generated from those change-notes.
313+
See [`unreleased-change-notes/README.md`](https://github.com/github/codeql-action/blob/main/unreleased-change-notes/README.md) for more information.
314+
token: ${{ secrets.GITHUB_TOKEN }}
315+
316+
- name: Mark the CHANGELOG.md concern as resolved
317+
if: >-
318+
needs.other-checks.outputs.changelog-modified == 'false' &&
319+
!startsWith(github.event.pull_request.head.ref, 'update-v') &&
320+
!startsWith(github.event.pull_request.head.ref, 'backport-v') &&
321+
!startsWith(github.event.pull_request.head.ref, 'mergeback/') &&
322+
!startsWith(github.event.pull_request.head.ref, 'update-bundle/')
323+
uses: ./.github/actions/post-comment
324+
with:
325+
marker: "post-comment:CHANGELOG.md"
326+
update-only: true
327+
body: |
328+
⚠️ `CHANGELOG.md` has been modified in this PR. Please do not modify `CHANGELOG.md` directly.
329+
Instead, create a change-note file in `unreleased-change-notes/`. The `CHANGELOG.md`
330+
file will be automatically generated from those change-notes.
331+
See [`unreleased-change-notes/README.md`](https://github.com/github/codeql-action/blob/main/unreleased-change-notes/README.md) for more information.
332+
333+
**Edit:** `CHANGELOG.md` is no longer modified in this PR. This concern is resolved.
334+
token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)