TRU-342: Document the split pin policy - #6
Merged
Merged
Conversation
zhianchow
previously approved these changes
Aug 6, 2026
zhianchow
left a comment
There was a problem hiding this comment.
Approving — the workflow table and consumption examples check out against the files at v1.4.0.
Verified
- All eight listed workflows exist in the repo.
- Adding terraform-docs to the
terraform-module-validation.yamlrow is accurate — it installs terraform-docs 0.16.0 with asha256sum -ccheck (as it does for tfsec 1.28.14). semantic-release.yamldoes have the optionalrelease_artifactinput and thesemveroutput described.- The
@v1.4.0in the example matches what the migrated consumers pin, andv1exists and currently resolves to the same commit asv1.4.0(1229f4e).
Non-blocking
- "Version tags are protected against modification" sits awkwardly next to a floating
v1. The ruleset coversrefs/tags/v*for creation/update/deletion with admin bypass — sov1is modified on every minor/patch, deliberately, by an admin. Half a sentence distinguishing immutablevX.Y.Zfrom the intentionally-movingv1would stop a reader concluding the floating tag can't be re-pointed. - Dropping the "Security posture" section is your call, and the tracker is the right home for review history. But "no secrets, so fork-triggered runs are safe" is the load-bearing justification for letting validation float on
@v1, and it now survives only as a parenthetical in the Consumption list. Worth keeping as a sentence — it's the reasoning a future reader needs to evaluate the split.
This was referenced Aug 6, 2026
Merged
zhianchow
approved these changes
Aug 6, 2026
zhianchow
left a comment
There was a problem hiding this comment.
Re-approving after 683a22fc. Both notes from my earlier review are resolved, and resolved accurately:
- The Versioning section now distinguishes immutable
vX.Y.Zfrom av1that is deliberately re-pointed each release, and correctly attributes both to the tag ruleset with admin-only movement. That matches what the ruleset actually does (refs/tags/v*, create/update/delete, repo-admin bypass). - The fork-safety rationale is back where it does the most good — inline in the Consumption bullet, as the reason a floating pin is acceptable for validation workflows rather than as a separate posture section a reader has to connect themselves.
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
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.
README refresh: documents the two consumption conventions (floating
@v1for validation workflows, exact pins for workflows that receive secrets) and trims the README to what external readers need — workflow catalogue, consumption examples, versioning. Internal context (tickets, rationale, review history) lives in the tracker, not here.