Skip to content

chore(ci): trim workflow comments and log messages - #32

Merged
henrypalacios merged 1 commit into
mainfrom
chore/ci-comment-hygiene
Aug 28, 2026
Merged

chore(ci): trim workflow comments and log messages#32
henrypalacios merged 1 commit into
mainfrom
chore/ci-comment-hygiene

Conversation

@henrypalacios

@henrypalacios henrypalacios commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Reduce the comments in the workflow files to a plain statement of what each step does.
  • Drop the header note block in both publish workflows; the jobs it described already document themselves.
  • Reword the two fallback log messages in CI.yml so they report the step's exit status and nothing more.

Changes

File Change
.github/workflows/CI.yml Drop four comments above the test and audit steps; reword both fallback log messages
.github/workflows/publish-protocol-core.yaml Drop the header note block
.github/workflows/publish-sdk.yaml Drop the header note block

Behaviour

No functional change. Parsing both revisions of all three workflows yields identical structure and identical key sets. The only value differences anywhere are the two log message strings in CI.yml; the commands they follow are unchanged. Both publish workflows show zero parsed differences — every line removed there is a comment.

Step commands, continue-on-error declarations, triggers, permissions, conditions, needs:, environment:, concurrency:, job names and action pins are all untouched.

Net effect is 2 insertions and 18 deletions, every one of them a comment or a log message.

Test plan

  • All three workflows parse as valid YAML
  • Parsed key sets identical to main in all three files
  • Only leaf value deltas are the two echo message strings in CI.yml; both publish workflows show zero parsed deltas
  • Every added or removed line in the branch diff is a comment or an echo string

Reduce workflow comments to a plain statement of what each step does,
removing header notes that duplicate what the jobs already document.
Reword the two fallback log messages in CI.yml. No change to any step's
command, trigger, permission, condition or action pin.
@henrypalacios
henrypalacios force-pushed the chore/ci-comment-hygiene branch from 080a11b to 71be0e7 Compare August 28, 2026 01:54
@henrypalacios
henrypalacios merged commit 97ee702 into main Aug 28, 2026
2 checks passed
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