-
Notifications
You must be signed in to change notification settings - Fork 94
fix(skills): start tag annotation with blank line when no custom title #1239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -64,8 +64,9 @@ Use `AskUserQuestion` to ask: | |
| > Any special title for this release? (e.g. "MVP Release Candidate 1") | ||
| > Leave blank to use just the version tag. | ||
|
|
||
| The answer becomes the tag subject line. If blank, leave the subject empty | ||
| so GoReleaser's `name_template` renders just the tag without duplication. | ||
| The answer becomes the tag subject line. If blank, use the tag name itself as | ||
| the subject so that GoReleaser's `name_template` guard (`ne .TagSubject .Tag`) | ||
| suppresses it, producing a clean release title without duplication. | ||
|
|
||
| ### 5. Gather changes since last tag | ||
|
|
||
|
|
@@ -81,9 +82,12 @@ Summarize changes into categories (features, fixes, refactors). Exclude | |
| Build the tag message: | ||
|
|
||
| - **Line 1 (subject):** The custom title from step 4, if one was given. | ||
| If no custom title, **omit the subject line** — start the annotation | ||
| body directly with the highlights. This avoids duplicating the version | ||
| in the release title. | ||
| If no custom title, **use the tag name itself** (e.g. `v0.9.0`) — git's | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [low] prose-style Step 4 bolds the negation (do not use) while step 6 bolds the entire phrase (use the tag name itself). Minor emphasis inconsistency — consider bolding just the verb for consistency. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [info] documentation-detail Step 6 explanation includes significantly more technical detail about %(contents:subject) behavior and GoReleaser guard mechanics compared to surrounding sections. Consider moving git internals explanation to a note or near the existing name_template paragraph. |
||
| `%(contents:subject)` skips leading blank lines, so a blank first line | ||
| still picks up the first category header as `.TagSubject`. Using the tag | ||
| name as subject ensures `.TagSubject == .Tag`, which the goreleaser guard | ||
| suppresses, producing a clean release title with no suffix. | ||
| - **Line 2:** Blank. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [low] formatting-inconsistency The new three-bullet structure (Line 1, Line 2, Lines 3+) differs from the original two-bullet pattern. Making the blank line explicit improves clarity, but consider incorporating it into the Line 1 bullet to maintain a two-item structure. |
||
| - **Lines 3+:** Summary of highlights organized by category. | ||
|
|
||
| ``` | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[info] documentation-clarity
Updated step 4 and step 6 now correctly explain the underlying mechanism (setting .TagSubject == .Tag to trigger the guard) rather than the prior incorrect instruction to leave the subject empty. Clear improvement.