Draft
Conversation
- Add .claude/skills/release-note/ skill that automates generating and polishing release notes from a GitHub milestone - Add references/style-guide.md with annotated formatting examples - Add release notes for Armeria 1.38.0 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughAdds a new Claude skill workflow for end-to-end release note generation and polishing, a detailed Armeria release-notes style guide, and the finalized v1.38.0 release notes page. Changes
Sequence Diagram(s)sequenceDiagram
participant User as User
participant Claude as Claude Skill
participant GH as GitHub API
participant Gen as site-new generator
participant FS as File System
rect rgba(200,220,255,0.5)
User->>Claude: trigger /release-note <version>
end
rect rgba(200,255,220,0.5)
Claude->>GH: validate milestone exists
GH-->>Claude: milestone status
Claude->>Gen: run release-note generator
Gen-->>Claude: draft MDX path
Claude->>FS: verify draft file exists
FS-->>Claude: file content
end
rect rgba(255,230,200,0.5)
Claude->>GH: fetch PRs/issues referenced & metadata
GH-->>Claude: PR/issue data + comments + files
Claude->>Claude: triage "🗑 Maybe ignore" entries
Claude->>Claude: rewrite entries per style-guide
Claude->>FS: write finalized MDX
FS-->>Claude: write confirmation
end
Claude-->>User: summary + per-section counts + uncertain items
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (6)
.claude/skills/release-note/SKILL.md (6)
37-39: Add language identifier to code block.The shell command block should specify
shellorbashfor proper syntax highlighting.📝 Proposed fix
- ``` + ```shell cd site-new && npm run release-note <version> ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.claude/skills/release-note/SKILL.md around lines 37 - 39, The fenced code block containing the shell command `cd site-new && npm run release-note <version>` needs a language identifier for proper syntax highlighting; update the block start from ``` to ```shell (or ```bash) so the snippet is ```shell cd site-new && npm run release-note <version> ``` which ensures correct highlighting in SKILL.md.
55-57: Add language identifier to code block.The shell command block should specify
shellorbashfor proper syntax highlighting.📝 Proposed fix
- ``` + ```shell gh pr view <number> --repo line/armeria --json title,body,labels,files ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.claude/skills/release-note/SKILL.md around lines 55 - 57, The code block showing the GitHub CLI command `gh pr view <number> --repo line/armeria --json title,body,labels,files` needs a language identifier for proper syntax highlighting; update the fenced code block around that command to include a shell identifier such as "shell" or "bash" (e.g., change the opening ``` to ```shell) so the `gh pr view` command is highlighted correctly in the rendered document.
67-70: Add language identifier to code blocks.Both shell command blocks should specify
shellorbashfor proper syntax highlighting.📝 Proposed fix
- ``` + ```shell gh issue view <number> --repo line/armeria --json title,body gh api repos/line/armeria/issues/<number>/comments --jq '.[].body' ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.claude/skills/release-note/SKILL.md around lines 67 - 70, Update the Markdown code fences around the two shell command blocks so they include a language identifier (e.g., "shell" or "bash") for proper syntax highlighting; locate the fenced block that contains the commands "gh issue view <number> --repo line/armeria --json title,body" and "gh api repos/line/armeria/issues/<number>/comments --jq '.[].body'" and change the opening triple backticks to ```shell (or ```bash) to annotate the block.
61-63: Add language identifier to code block.The shell command block should specify
shellorbashfor proper syntax highlighting.📝 Proposed fix
- ``` + ```shell gh api repos/line/armeria/pulls/<number>/comments --jq '.[].body' ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.claude/skills/release-note/SKILL.md around lines 61 - 63, The fenced code block containing the command "gh api repos/line/armeria/pulls/<number>/comments --jq '.[].body'" needs a language identifier for proper highlighting; update the triple-backtick fence to include "shell" or "bash" (e.g., ```shell) before that command so the snippet in SKILL.md renders with shell/bash syntax highlighting.
22-24: Add language identifier to code block.The code block should specify
shellorbashfor proper syntax highlighting.📝 Proposed fix
-``` +```shell /release-note <version></details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In @.claude/skills/release-note/SKILL.md around lines 22 - 24, Update the fenced
code block that currently contains "/release-note " in SKILL.md to
include a language identifier (e.g., shell or bash) for proper syntax
highlighting; locate the triple-backtick block around the "/release-note
" snippet and change the opening fence fromtoshell (or
33-35: Add language identifier to code block.The shell command block should specify
shellorbashfor proper syntax highlighting.📝 Proposed fix
- ``` + ```shell gh api repos/line/armeria/milestones --jq '.[] | select(.title == "<version>") | .number' ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.claude/skills/release-note/SKILL.md around lines 33 - 35, Update the fenced code block containing the GitHub CLI command "gh api repos/line/armeria/milestones --jq '.[] | select(.title == \"<version>\") | .number'" to include a language identifier (e.g., ```shell or ```bash) immediately after the opening backticks so the snippet renders with proper shell syntax highlighting in the SKILL.md document.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.claude/skills/release-note/SKILL.md:
- Around line 37-39: The fenced code block containing the shell command `cd
site-new && npm run release-note <version>` needs a language identifier for
proper syntax highlighting; update the block start from ``` to ```shell (or
```bash) so the snippet is ```shell cd site-new && npm run release-note
<version> ``` which ensures correct highlighting in SKILL.md.
- Around line 55-57: The code block showing the GitHub CLI command `gh pr view
<number> --repo line/armeria --json title,body,labels,files` needs a language
identifier for proper syntax highlighting; update the fenced code block around
that command to include a shell identifier such as "shell" or "bash" (e.g.,
change the opening ``` to ```shell) so the `gh pr view` command is highlighted
correctly in the rendered document.
- Around line 67-70: Update the Markdown code fences around the two shell
command blocks so they include a language identifier (e.g., "shell" or "bash")
for proper syntax highlighting; locate the fenced block that contains the
commands "gh issue view <number> --repo line/armeria --json title,body" and "gh
api repos/line/armeria/issues/<number>/comments --jq '.[].body'" and change the
opening triple backticks to ```shell (or ```bash) to annotate the block.
- Around line 61-63: The fenced code block containing the command "gh api
repos/line/armeria/pulls/<number>/comments --jq '.[].body'" needs a language
identifier for proper highlighting; update the triple-backtick fence to include
"shell" or "bash" (e.g., ```shell) before that command so the snippet in
SKILL.md renders with shell/bash syntax highlighting.
- Around line 22-24: Update the fenced code block that currently contains
"/release-note <version>" in SKILL.md to include a language identifier (e.g.,
shell or bash) for proper syntax highlighting; locate the triple-backtick block
around the "/release-note <version>" snippet and change the opening fence from
``` to ```shell (or ```bash).
- Around line 33-35: Update the fenced code block containing the GitHub CLI
command "gh api repos/line/armeria/milestones --jq '.[] | select(.title ==
\"<version>\") | .number'" to include a language identifier (e.g., ```shell or
```bash) immediately after the opening backticks so the snippet renders with
proper shell syntax highlighting in the SKILL.md document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 89b0212c-d376-41ee-9b20-cfb0b9feb4b2
📒 Files selected for processing (3)
.claude/skills/release-note/SKILL.md.claude/skills/release-note/references/style-guide.mdsite-new/src/content/release-notes/1.38.0.mdx
- Always include core maintainers from CODEOWNERS in Thank You section - Clarify issue/PR reference format in style guide Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.claude/skills/release-note/references/style-guide.md:
- Around line 34-35: The guideline "`#6607` issue/PR references at end of
description line (list both the issue and the PR)" conflicts with the examples
that show single-reference entries; update the document so the rule and examples
are consistent by either (A) revising the rule to allow a single reference when
only one identifier exists (e.g., keep examples as-is and add a sentence like
"If only an issue OR a PR exists, a single reference is acceptable"), or (B)
changing the examples to always show paired issue+PR references; ensure you
update the rule text (the quoted rule) and all example instances that currently
show single references (those around the examples that follow the rule) so they
match the clarified policy.
- Around line 11-27: The MDX block currently opens with ```mdx and then contains
an inner ```java fence which prematurely closes the outer block; update the
outer fence to a longer delimiter so the inner ```java can be nested (e.g.
change the outer ```mdx start and its matching closing fence to ````mdx / ````),
ensuring the inner ```java ... ``` remains intact and the MD040 lint error is
resolved; look for the ```mdx and ```java fences around the "Standalone Athenz
Token Validation" example to apply this change.
In @.claude/skills/release-note/SKILL.md:
- Around line 22-24: Add the missing language identifiers ("bash") to the fenced
code blocks in .claude/skills/release-note/SKILL.md so markdownlint MD040 is
satisfied; locate the code fences containing the command snippets (e.g. the
block with "/release-note <version>", and the blocks containing "gh api
repos/line/armeria/milestones --jq '.[] | select(.title == \"<version>\") |
.number'", "cd site-new && npm run release-note <version>", "gh pr view <number>
--repo line/armeria --json title,body,labels,files", "gh api
repos/line/armeria/pulls/<number>/comments --jq '.[].body'", and the
issue/comment query blocks) and change each opening triple backtick to ```bash
so every command fence is annotated with the bash language.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 7220df8a-3acf-402a-81ee-a4b0951a77a8
📒 Files selected for processing (3)
.claude/skills/release-note/SKILL.md.claude/skills/release-note/references/style-guide.mdsite-new/src/content/release-notes/1.38.0.mdx
✅ Files skipped from review due to trivial changes (1)
- site-new/src/content/release-notes/1.38.0.mdx
Contributor
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6702 +/- ##
============================================
- Coverage 74.46% 73.95% -0.51%
- Complexity 22234 24019 +1785
============================================
Files 1963 2170 +207
Lines 82437 90107 +7670
Branches 10764 11807 +1043
============================================
+ Hits 61385 66641 +5256
- Misses 15918 17884 +1966
- Partials 5134 5582 +448 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
1 participant
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.
.claude/skills/release-note/skill that automates generating and polishing release notes from a GitHub milestone