fix(github): drop publish options and fix preamble heading level in the pull request cheatsheet - #195
Merged
Merged
Conversation
…he pull request cheatsheet Comment options are read by the pull request flow only, so the `publish` parameters and the "publish with specific access and tag" example in the cheatsheet never took effect. The cheatsheet now lists the `bump` options and says where release-time options belong. The `set-preamble` examples start at `###` — the level of the generated changelog sections — instead of `##`, which is the version header level; the release automation docs page gets the same fix.
Coverage Report for CI Build 33971585615Coverage remained the same at 63.087%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
Merged
2 tasks
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
2 participants
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.
Summary
Comment options are read by the pull request flow only (
fetchOptionsinrunPullRequestAction); the release job runs on the merged commit and never reads comments. The cheatsheet in every release pull request body still advertisedpublishparameters and a "publish with specific access and tag" example, which never took effect. It now lists thebumpoptions and says where release-time options belong.The
set-preambleexamples in the cheatsheet and on the release automation docs page started at##, the level of the version header. A preamble belongs at###, the level of the generated sections (### Features), as in TrigenSoftware/nano_kit#186. Both places now say so and use###.No behavior change.
Test plan
pnpm --filter @simple-release/github test(lint, unit, types)🤖 Generated with Claude Code