STAC-25557: remove YAML-level comments from workflows - #370
Open
LouisParkin wants to merge 1 commit into
Open
Conversation
House convention is uncommented YAML; the migration workflows had accumulated a lot of it (225 of 525 lines in checks-tests.yml). Shell comments inside `run:` blocks are kept deliberately. They are string content rather than YAML syntax, and they explain non-obvious runtime behaviour at the point of use. Verified a pure comment removal, not a rewrite: every file parses to an identical document before and after, and all 16 `run:` blocks are byte-identical. actionlint and Zizmor clean. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
House convention is uncommented YAML. The migration workflows had drifted a long way from it — 225 of 525 lines in
checks-tests.yml.Pure deletion, 258 lines, no behaviour change.
Shell comments inside
run:blocks are kept: they're string content rather than YAML syntax, and they explain non-obvious runtime behaviour where it applies.Verification
Checked mechanically rather than by eye, since a comment strip is easy to get subtly wrong:
run:blocks byte-identicalCompanion PR for
stackstate-process-agentfollows under the same ticket.