workflows: minimal structured header comments (reference for the fleet rework) - #277
Merged
Merged
Conversation
Rework the verbose block comments to a one-line summary + '-' bullets, one idea per line, ASCII dashes, and clauses rejoined properly instead of a ';'/em-dash deleted into a run-on. First reference for the fleet-wide workflow-comment style. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates this template repo's GitHub Actions workflow header comments to a minimal, structured, no-prose style that serves as the reference for an upcoming fleet-wide comment rework.
Changes:
- Reworks
.github/workflows/merge-bot-pull-request.ymlheader and concurrency rationale comments into a concise, structured bullet format. - Rephrases two comments in
.github/workflows/publish-release.ymlto avoid semicolon-style run-ons while keeping the same meaning.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/publish-release.yml | Reflows/rewrites header and release-existence comments for clearer, minimal phrasing. |
| .github/workflows/merge-bot-pull-request.yml | Replaces verbose header/concurrency/maintainer-push comments with a structured, compact format. |
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.
First reference PR for the fleet-wide workflow-comment rework (approved style).
Reworks the verbose block comments in the template's own workflows to a minimal, structured, no-prose shape:
-bullets for each non-obvious why;;/em-dash deleted into a run-on.Files:
merge-bot-pull-request.yml(header + concurrency + the maintainer-push comment),publish-release.yml(two;run-ons).test-pull-request.ymlwas already concise and;-free. actionlint clean.This establishes the style; the fleet pass (catalog snippets + every repo's
.github/workflows/*, bundled with the CI-lint standardization) follows.🤖 Generated with Claude Code