Skip to content

Commit 1b941fe

Browse files
hannesrudolphhannesrudolph
committed
feat: add release notes for version 3.21.2 and update sidebar links
chore: remove temporary PR analysis notes for version 3.21.3 feat: add release notes for version 3.21.3 and update sidebar links feat: implement subtask-based PR processing and enhance contributor acknowledgment in release notes
1 parent 1632ed0 commit 1b941fe

File tree

13 files changed

+688
-74
lines changed

13 files changed

+688
-74
lines changed

‎.roo/rules-release-notes-writer/1_workflow.xml‎

Lines changed: 85 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -49,40 +49,98 @@
4949
</steps>
5050
</phase>
5151
<phase name="process_each_pr">
52-
<description>For each PR, follow a micro-workflow to gather, analyze, and write to a temporary file.</description>
53-
<micro_workflow>
52+
<description>Process PRs individually, investigating each one thoroughly and storing findings in a temporary file for later compilation.</description>
53+
<iterative_workflow>
54+
<overview>
55+
For each PR in the list, execute a complete investigation workflow and immediately
56+
store the findings in a temporary markdown file (e.g., temp_pr_analysis.md).
57+
This allows for incremental building of release note data.
58+
</overview>
59+
60+
<per_pr_steps>
61+
<step number="1">
62+
<action>Gather comprehensive PR details</action>
63+
<tools>
64+
<tool>github.get_pull_request - Title, author, description</tool>
65+
<tool>github.get_pull_request_files - Changed files (optional)</tool>
66+
<tool>github.get_pull_request_diff - Code changes (if needed for clarity)</tool>
67+
</tools>
68+
<details>Extract PR title, author username, and description for analysis</details>
69+
</step>
70+
71+
<step number="2">
72+
<action>Extract and gather linked issue details</action>
73+
<process>
74+
<substep>Parse PR description for issue references (Fixes #123, Closes #456, etc.)</substep>
75+
<substep>For each found issue number, use github.get_issue to gather details</substep>
76+
<substep>Extract issue reporter username and title for context</substep>
77+
</process>
78+
<tools>
79+
<tool>github.get_issue - For each linked issue found</tool>
80+
</tools>
81+
</step>
82+
83+
<step number="3">
84+
<action>Analyze and categorize the change</action>
85+
<analysis_framework>
86+
<question>What changed? (core functionality/feature affected)</question>
87+
<question>Why did it change? (problem being solved)</question>
88+
<question>How does this impact users? (benefits in plain language)</question>
89+
<question>What category? (bug fix, feature, improvement, etc.)</question>
90+
</analysis_framework>
91+
</step>
92+
93+
<step number="4">
94+
<action>Write findings to temporary file</action>
95+
<process>
96+
<substep>Create or append to temp_pr_analysis.md</substep>
97+
<substep>Include structured data for this PR</substep>
98+
<substep>Store all contributor information</substep>
99+
<substep>Include categorization and user impact analysis</substep>
100+
</process>
101+
<file_format>
102+
Use a consistent markdown format that can be easily parsed later
103+
for generating the final release notes
104+
</file_format>
105+
</step>
106+
</per_pr_steps>
107+
108+
<completion_per_pr>
109+
After each PR analysis is complete and written to the temporary file,
110+
move on to the next PR. This ensures thorough investigation of each
111+
change before proceeding.
112+
</completion_per_pr>
113+
</iterative_workflow>
114+
</phase>
115+
<phase name="compile_final_release_notes">
116+
<description>Read the temporary analysis file and compile all findings into the final release notes format</description>
117+
<steps>
54118
<step number="1">
55-
<action>Gather comprehensive PR details</action>
56-
<tools>
57-
<tool>github.get_pull_request - Title, author, description</tool>
58-
<tool>github.get_pull_request_files - Changed files</tool>
59-
<tool>github.get_pull_request_diff - Code changes</tool>
60-
<tool>github.get_pull_request_comments - Additional context if needed</tool>
61-
</tools>
119+
<action>Read temporary analysis file</action>
120+
<details>
121+
Read the complete temp_pr_analysis.md file that contains all individual PR investigations
122+
</details>
62123
</step>
63124
<step number="2">
64-
<action>Gather related issue details</action>
65-
<tools>
66-
<tool>github.get_issue</tool>
67-
</tools>
68-
<details>From the PR description, extract the issue number and retrieve details.</details>
125+
<action>Group and organize findings</action>
126+
<details>
127+
Group PRs by category (Bug Fixes, QOL Improvements, Provider Updates, etc.)
128+
based on the analysis stored for each PR
129+
</details>
69130
</step>
70131
<step number="3">
71-
<action>Append analysis to temporary file</action>
132+
<action>Format for release notes</action>
72133
<details>
73-
Analyze the gathered information for a single PR and append the summary
74-
to a temporary file. This builds a comprehensive dataset incrementally.
75-
</details>
134+
Transform the organized findings into the final release notes format
135+
with proper acknowledgments and user-friendly language
136+
</details>
137+
</step>
138+
<step number="4">
139+
<action>Clean up temporary file</action>
140+
<details>
141+
Optionally remove or archive the temporary analysis file after successful completion
142+
</details>
76143
</step>
77-
</micro_workflow>
78-
</phase>
79-
<phase name="transform_to_user_benefits">
80-
<description>Analyze technical changes from the temporary file and convert to user-facing benefits based on the official changelog</description>
81-
<steps>
82-
<step>Identify what changed (core functionality/feature)</step>
83-
<step>Understand why it changed (problem being solved)</step>
84-
<step>Determine user impact (benefits in plain language)</step>
85-
<step>Categorize changes (features, fixes, improvements)</step>
86144
</steps>
87145
</phase>
88146
<phase name="generate_documentation">

‎.roo/rules-release-notes-writer/2_formatting_standards.xml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,28 @@ Concluding sentence about the overall benefit to users.
8282

8383
<contributor_acknowledgments>
8484
<format>(thanks username!)</format>
85+
<multiple_contributors>
86+
<format>(thanks username1, username2!)</format>
87+
<description>When multiple contributors are involved (PR author + issue reporter)</description>
88+
</multiple_contributors>
8589
<rules>
8690
<rule>Omit @ symbol from GitHub usernames</rule>
8791
<rule>Place before PR link in parentheses</rule>
8892
<rule>Use consistent format throughout</rule>
93+
<rule>Include both PR author and issue reporter when available</rule>
94+
<rule>List PR author first, then issue reporter</rule>
95+
<rule>Separate multiple usernames with commas</rule>
8996
</rules>
97+
<examples>
98+
<example>
99+
<description>PR author only</description>
100+
<format>(thanks john-doe!)</format>
101+
</example>
102+
<example>
103+
<description>PR author + issue reporter</description>
104+
<format>(thanks john-doe, jane-smith!)</format>
105+
</example>
106+
</examples>
90107
</contributor_acknowledgments>
91108

92109
<pr_links>

‎.roo/rules-release-notes-writer/3_pr_analysis_patterns.xml‎

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
<structure><![CDATA[
5757
## [User-Friendly Feature Name]
5858
59-
We've [high-level description of improvement] (thanks [Author]!) ([#PR_NUMBER](https://github.com/RooCodeInc/Roo-Code/pull/PR_NUMBER)):
59+
We've [high-level description of improvement] (thanks [Contributors]!) ([#PR_NUMBER](https://github.com/RooCodeInc/Roo-Code/pull/PR_NUMBER)):
6060
6161
- **[Benefit Category 1]**: [How this helps users in plain language]
6262
- **[Benefit Category 2]**: [Another user benefit explained simply]
@@ -67,7 +67,7 @@ We've [high-level description of improvement] (thanks [Author]!) ([#PR_NUMBER](h
6767
<example><![CDATA[
6868
## Intelligent Context Condensing Now Default
6969
70-
We've made our smart context management the default behavior for all conversations (thanks john-doe!) ([#1234](https://github.com/RooCodeInc/Roo-Code/pull/1234)):
70+
We've made our smart context management the default behavior for all conversations (thanks john-doe, issue-reporter!) ([#1234](https://github.com/RooCodeInc/Roo-Code/pull/1234)):
7171
7272
- **Better Performance**: Conversations stay fast even with large codebases
7373
- **Smarter Responses**: Roo focuses on the most relevant code for your current task
@@ -79,21 +79,45 @@ This means you can work with larger projects without worrying about context mana
7979

8080
<template type="bug_fix">
8181
<structure><![CDATA[
82-
* **[Problem Fixed]**: [Brief description of what users can now do] (thanks [Author]!) ([#PR](link))
82+
* **[Problem Fixed]**: [Brief description of what users can now do] (thanks [Contributors]!) ([#PR](link))
8383
]]></structure>
8484
<example><![CDATA[
85-
* **File Editing**: Fixed issue where large files couldn't be edited properly (thanks jane-smith!) ([#1235](https://github.com/RooCodeInc/Roo-Code/pull/1235))
85+
* **File Editing**: Fixed issue where large files couldn't be edited properly (thanks jane-smith, bug-reporter!) ([#1235](https://github.com/RooCodeInc/Roo-Code/pull/1235))
8686
]]></example>
8787
</template>
8888

8989
<template type="improvement">
9090
<structure><![CDATA[
91-
* **[Area Improved]**: [What's better for users] ([#PR](link))
91+
* **[Area Improved]**: [What's better for users] (thanks [Contributors]!) ([#PR](link))
9292
]]></structure>
9393
<example><![CDATA[
94-
* **Search Performance**: Code searches now complete 2x faster for large projects ([#1236](https://github.com/RooCodeInc/Roo-Code/pull/1236))
94+
* **Search Performance**: Code searches now complete 2x faster for large projects (thanks perf-dev, suggester!) ([#1236](https://github.com/RooCodeInc/Roo-Code/pull/1236))
9595
]]></example>
9696
</template>
97+
98+
<contributor_identification>
99+
<pr_author>
100+
<description>Always include the PR author as the primary contributor</description>
101+
<source>user.login field from github.get_pull_request</source>
102+
</pr_author>
103+
<issue_reporter>
104+
<description>Include issue reporter when PR references an issue</description>
105+
<source>user.login field from github.get_issue for linked issues</source>
106+
<patterns>
107+
<pattern>Fixes #123</pattern>
108+
<pattern>Closes #456</pattern>
109+
<pattern>Resolves #789</pattern>
110+
<pattern>Fix #101</pattern>
111+
<pattern>Close #202</pattern>
112+
</patterns>
113+
</issue_reporter>
114+
<ordering>
115+
<rule>List PR author first</rule>
116+
<rule>List issue reporter(s) second</rule>
117+
<rule>Separate multiple contributors with commas</rule>
118+
<rule>Remove duplicates if same person is both PR author and issue reporter</rule>
119+
</ordering>
120+
</contributor_identification>
97121
</pr_templates>
98122

99123
<categorization_guide>
@@ -187,4 +211,50 @@ This means you can work with larger projects without worrying about context mana
187211
<keywords>secure, safe, protected</keywords>
188212
</category>
189213
</benefit_categories>
214+
215+
<subtask_mode_patterns>
216+
<description>
217+
Patterns specific to operating as a subtask for single PR investigation
218+
</description>
219+
<message_recognition>
220+
<pattern>Investigate PR #(\d+) for release notes v([\d.]+)</pattern>
221+
<extraction>
222+
<field name="pr_number">First capture group</field>
223+
<field name="version">Second capture group</field>
224+
</extraction>
225+
</message_recognition>
226+
<workflow_differences>
227+
<difference>
228+
<main_mode>Processes multiple PRs in sequence</main_mode>
229+
<subtask_mode>Focuses on single PR investigation</subtask_mode>
230+
</difference>
231+
<difference>
232+
<main_mode>Creates complete release notes files</main_mode>
233+
<subtask_mode>Appends findings to temp_pr_analysis.md</subtask_mode>
234+
</difference>
235+
<difference>
236+
<main_mode>Updates multiple documentation files</main_mode>
237+
<subtask_mode>Only writes to temporary analysis file</subtask_mode>
238+
</difference>
239+
</workflow_differences>
240+
<output_format>
241+
<description>Standardized format for subtask findings</description>
242+
<template><![CDATA[
243+
## PR #[number]: [Title]
244+
245+
**Author**: [username]
246+
**Linked Issues**: #[issue] (reporter: [username]), ...
247+
**Category**: [Bug Fix/Feature/Improvement/etc.]
248+
**User Impact**: [Clear description of benefit to users]
249+
**Contributors**: [all contributors including PR author and issue reporters]
250+
251+
---
252+
]]></template>
253+
<notes>
254+
<note>Always append to temp_pr_analysis.md using insert_content with line 0</note>
255+
<note>Include the separator (---) to clearly delineate entries</note>
256+
<note>Maintain consistent formatting for easy parsing</note>
257+
</notes>
258+
</output_format>
259+
</subtask_mode_patterns>
190260
</pr_analysis_patterns>

0 commit comments

Comments
 (0)