fix: release-doc-sync action checkout pollutes caller's working tree#20
Merged
TMHSDigital merged 1 commit intomainfrom Apr 25, 2026
Merged
fix: release-doc-sync action checkout pollutes caller's working tree#20TMHSDigital merged 1 commit intomainfrom
TMHSDigital merged 1 commit intomainfrom
Conversation
The composite action was checking out the meta-repo to a path inside
GITHUB_WORKSPACE (.release-doc-sync). The caller's release.yml does
git add -A after the action runs, which picked up the directory as
a 160000-mode gitlink (submodule pointer to meta-repo HEAD SHA).
Every release commit was polluted with this stale pointer.
Fix: move the meta-repo checkout to ${{ runner.temp }}/release-doc-sync,
which is outside the workspace and not visible to the caller's
git add. The action's run step's working-directory updated to match.
Surfaced during Phase 2b smoke test on Docker (#5).
Caught before Phase 2c parallel rollout could propagate the pollution
to 5 more tool repos.
Adds a regression test guarding against future re-introduction.
Signed-off-by: 154358121+TMHSDigital@users.noreply.github.com
Made-with: Cursor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
This was referenced Apr 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes a pollution bug surfaced during Phase 2b smoke test on Docker.
The
release-doc-synccomposite action was checking out the meta-repo to a path insideGITHUB_WORKSPACE(.release-doc-sync), causing the caller'sgit add -Astep to pick up the directory as a 160000-mode gitlink in every release commit (Subproject commit pointer to whatever SHAv1.0resolved to at the time).Fix
Move the meta-repo checkout to
${{ runner.temp }}/release-doc-sync(outside the workspace, invisible to the caller'sgit add).Path resolution remains correct in both directions:
${{ runner.temp }}/release-doc-sync/scripts/release_doc_sync/sync.py(relative to the new working-directory)CALLER_PATH=${{ github.workspace }}/${{ inputs.caller-path }}→--repo-path "$CALLER_PATH"Regression guard
Adds
test_meta_repo_checkout_is_outside_workspacetotests/test_release_doc_sync.py. The new test:path:containsrunner.tempand does not start with.(workspace-relative dot path).working-directory:matches the checkout path..release-doc-sync, passes on the fixed path.Combined with the existing
test_steps_follow_drift_check_pattern(now agnostic of specific path string), the constraint cannot be silently re-introduced.Why caught now
Surfaced during Phase 2b smoke test on
Docker-Developer-Tools(the canary forTMHSDigital/Developer-Tools-Directory#5). Inspection of the release commit (16afa03) showed:Caught before Phase 2c parallel rollout could propagate the pollution to 5 more tool repos.
VERSION: 1.8.0 → 1.8.1 (PATCH). After merge, the
v1.0floating tag will be force-updated to point at v1.8.1.Refs
TMHSDigital/Developer-Tools-Directory#5.