Skip to content

STAC-25557: remove YAML-level comments from workflows - #256

Open
LouisParkin wants to merge 1 commit into
masterfrom
STAC-25557-strip-yaml-comments
Open

STAC-25557: remove YAML-level comments from workflows#256
LouisParkin wants to merge 1 commit into
masterfrom
STAC-25557-strip-yaml-comments

Conversation

@LouisParkin

Copy link
Copy Markdown

House convention is uncommented YAML. Companion to StackVista/stackstate-agent-integrations#370 under the same ticket.

Pure deletion, 68 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

  • every file parses to an identical document before and after
  • all 12 run: blocks byte-identical
  • Zizmor reports the same 6 suppressions as pristine master (checked by running it on both), so nothing suppression-bearing was removed
  • the two shellcheck infos actionlint raises are pre-existing — necessarily, since no run: block changed

House convention is uncommented YAML. Companion to the same change in
stackstate-agent-integrations.

Shell comments inside `run:` blocks are kept: 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: every file parses to an identical document
before and after, and all 12 `run:` blocks are byte-identical. Zizmor reports
the same 6 suppressions as pristine master, and the two shellcheck infos
actionlint raises are pre-existing -- necessarily so, since no `run:` block
changed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@LouisParkin
LouisParkin requested a review from LouisLotter August 7, 2026 14:57
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.

1 participant