Skip to content

ci(docs): name disk-sizes commit author per workflow run#21278

Merged
bloxster merged 1 commit into
mainfrom
ci/disk-sizes-workflow-identity
May 19, 2026
Merged

ci(docs): name disk-sizes commit author per workflow run#21278
bloxster merged 1 commit into
mainfrom
ci/disk-sizes-workflow-identity

Conversation

@bloxster

Copy link
Copy Markdown
Collaborator

Summary

Addresses lystopad's review comment on #21100, which merged before it could be addressed.

The Configure git step in update-disk-sizes.yml was using the generic github-actions[bot] author. Lystopad's feedback:

Please, use another name here which would clearly points to this workflow. For example something like:

git config user.name "github-workflow-update-disk-sizes-run-${RUN_ID}"

Otherwise it would be hard to understand source of the change in target repo.

What changed

.github/workflows/update-disk-sizes.ymlConfigure git step:

       - name: Configure git
         if: steps.diff.outputs.changed == 'true'
+        env:
+          RUN_ID: ${{ github.run_id }}
         run: |
           set -euo pipefail
-          git config user.name "github-actions[bot]"
+          git config user.name "github-workflow-update-disk-sizes-run-${RUN_ID}"
           git config user.email "github-actions[bot]@users.noreply.github.com"
  • Name change: github-actions[bot]github-workflow-update-disk-sizes-run-<run-id>. The auto-update commit now names the specific workflow and the exact run, so anyone investigating the commit in the target repo can jump straight to the run that produced it.
  • RUN_ID propagated via env: block, consistent with the rest of the workflow's anti-template-injection pattern (no template substitution into shell).
  • user.email unchangedgithub-actions[bot]@users.noreply.github.com still keeps the commit attributed to the bot. Lystopad's suggestion only addressed user.name.

Test plan

  • YAML syntax check (yamllint-style by visual inspection — single env: insertion)
  • First update-disk-sizes workflow run after merge: confirm the produced chore(docs): auto-update measured disk sizes commit has author github-workflow-update-disk-sizes-run-<id> (where <id> matches the workflow run ID linked from the commit annotation)

Related: #21100, #21271

Addresses lystopad's review comment on #21100 (landed unaddressed):
the generic "github-actions[bot]" author makes it hard to identify
which workflow produced the disk-sizes auto-update commit in the
target repo.

Switch to "github-workflow-update-disk-sizes-run-${RUN_ID}", which:
- names the specific workflow (not all github-actions bot commits)
- includes the run ID so the commit trail points directly back to
  the workflow execution that produced it

RUN_ID is propagated via env: block, consistent with the rest of the
workflow's anti-template-injection pattern. user.email is unchanged
(github-actions[bot]@users.noreply.github.com).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refines the docs automation workflow so that commits created by update-disk-sizes.yml are authored with a workflow/run-specific user.name, making it easier to trace auto-updates back to the exact GitHub Actions run that produced them.

Changes:

  • Update the Configure git step to set git config user.name to github-workflow-update-disk-sizes-run-${RUN_ID}, with RUN_ID sourced via a step env: block (github.run_id).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bloxster bloxster added this pull request to the merge queue May 19, 2026
Merged via the queue into main with commit 16e906f May 19, 2026
73 checks passed
@bloxster bloxster deleted the ci/disk-sizes-workflow-identity branch May 19, 2026 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants