Add github:what-next cmd #215
Conversation
Signed-off-by: David Martin <davmarti@redhat.com>
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: david-martin The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
WalkthroughA new GitHub plugin is introduced with a what-next command that analyzes pull requests, issues, and milestones to prioritize work. The plugin is registered in the marketplace, documented, and added to the data registry alongside command specifications. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (7 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
openshift-ci
bot
added
the
needs-ok-to-test
|
Hi @david-martin. Thanks for your PR. I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (6)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/github/.claude-plugin/plugin.json(1 hunks)plugins/github/README.md(1 hunks)plugins/github/commands/what-next.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
plugins/github/commands/what-next.md
[uncategorized] ~6-~6: The official name of this software platform is spelled with a capital “H”.
Context: ...int: [--contributing path] --- ## Name github:what-next ## Synopsis ``` /github:what...
(GITHUB)
[uncategorized] ~15-~15: The official name of this software platform is spelled with a capital “H”.
Context: ...tributing path] ``` ## Description The github:what-next command helps developers ide...
(GITHUB)
plugins/github/README.md
[uncategorized] ~9-~9: The official name of this software platform is spelled with a capital “H”.
Context: ...scription | |---------|-------------| | /github:what-next | Identify what to focus on ...
(GITHUB)
PLUGINS.md
[uncategorized] ~133-~133: The official name of this software platform is spelled with a capital “H”.
Context: ...ME.md) for detailed documentation. ### Github Plugin GitHub workflow automation and ...
(GITHUB)
[uncategorized] ~140-~140: The official name of this software platform is spelled with a capital “H”.
Context: ...s, issues, and milestones See plugins/github/README.md fo...
(GITHUB)
[uncategorized] ~140-~140: The official name of this software platform is spelled with a capital “H”.
Context: ...ilestones See plugins/github/README.md for detailed documentation. ...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
plugins/github/README.md
25-25: Bare URL used
(MD034, no-bare-urls)
34-34: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
46-46: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (5)
plugins/github/.claude-plugin/plugin.json (1)
1-8: Manifest structure is correct.The plugin manifest follows established conventions and is valid. No concerns here.
.claude-plugin/marketplace.json (1)
131-136: Marketplace entry is well-formed.The new plugin entry is properly formatted, correctly positioned, and maintains JSON validity.
plugins/github/commands/what-next.md (1)
1-226: Comprehensive and well-structured command specification.The what-next command specification is thorough, with clear implementation steps, well-defined heuristics, comprehensive error handling, and practical examples. The five-step process for gathering and prioritizing work items is logical and actionable.
docs/data.json (1)
985-1000: Plugin metadata is correct and consistent.The github plugin entry in docs/data.json properly declares the what-next command with matching argument hints, descriptions, and synopses across all related files. The metadata structure is consistent with other plugin entries.
plugins/github/README.md (1)
9-9: Capitalize company name "GitHub".The static analysis correctly flagged that the official name should be capitalized.
| Command | Description | |---------|-------------| -| `/github:what-next` | Identify what to focus on next based on PRs, issues, and milestones | +| `/GitHub:what-next` | Identify what to focus on next based on PRs, issues, and milestones |Note: The command name itself (
/github:what-next) should remain lowercase in actual usage, but the text describing "GitHub workflow" should use proper capitalization.Likely an incorrect or invalid review comment.
| - [Doc](#doc-plugin) | ||
| - [Etcd](#etcd-plugin) | ||
| - [Git](#git-plugin) | ||
| - [Github](#github-plugin) |
There was a problem hiding this comment.
Capitalize GitHub in table of contents.
The company name should use proper capitalization throughout the document.
- [Github](#github-plugin)
+ [GitHub](#github-plugin)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Github](#github-plugin) | |
| - [GitHub](#github-plugin) |
🤖 Prompt for AI Agents
In PLUGINS.md around line 14, the table-of-contents entry "Github" should be
capitalized as "GitHub"; update that line to "GitHub" and scan the document for
any other instances of "Github" to correct them to "GitHub" for consistent
casing, leaving existing anchors/links intact unless their target headings also
need capitalization changes to match.
| ### Github Plugin | ||
|
|
||
| GitHub workflow automation and utilities | ||
|
|
||
| **Commands:** | ||
| - **`/github:what-next` `[--contributing path]`** - Identify what to focus on next based on PRs, issues, and milestones | ||
|
|
||
| See [plugins/github/README.md](plugins/github/README.md) for detailed documentation. |
There was a problem hiding this comment.
Capitalize GitHub in plugin section header and link path.
The plugin section header and internal references should use the proper capitalization of the company name, though the fragment identifier should remain lowercase.
-### Github Plugin
+### GitHub Plugin
-GitHub workflow automation and utilities
+GitHub workflow automation and utilities
**Commands:**
- **`/github:what-next` `[--contributing path]`** - Identify what to focus on next based on PRs, issues, and milestones
-See [plugins/github/README.md](plugins/github/README.md) for detailed documentation.
+See [plugins/github/README.md](plugins/github/README.md) for detailed documentation.Note: The command name and path remain lowercase as intended.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Github Plugin | |
| GitHub workflow automation and utilities | |
| **Commands:** | |
| - **`/github:what-next` `[--contributing path]`** - Identify what to focus on next based on PRs, issues, and milestones | |
| See [plugins/github/README.md](plugins/github/README.md) for detailed documentation. | |
| ### GitHub Plugin | |
| GitHub workflow automation and utilities | |
| **Commands:** | |
| - **`/github:what-next` `[--contributing path]`** - Identify what to focus on next based on PRs, issues, and milestones | |
| See [plugins/github/README.md](plugins/github/README.md) for detailed documentation. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~133-~133: The official name of this software platform is spelled with a capital “H”.
Context: ...ME.md) for detailed documentation. ### Github Plugin GitHub workflow automation and ...
(GITHUB)
[uncategorized] ~140-~140: The official name of this software platform is spelled with a capital “H”.
Context: ...s, issues, and milestones See plugins/github/README.md fo...
(GITHUB)
[uncategorized] ~140-~140: The official name of this software platform is spelled with a capital “H”.
Context: ...ilestones See plugins/github/README.md for detailed documentation. ...
(GITHUB)
🤖 Prompt for AI Agents
PLUGINS.md around lines 133-140: change the section header from "Github Plugin"
to "GitHub Plugin" and update the internal README link from
"plugins/github/README.md" to use the proper capitalization
("plugins/GitHub/README.md"); keep the command name and any fragment identifiers
in lowercase as they are.
|
|
||
| - **GitHub CLI (`gh`)** must be installed and authenticated | ||
| - Check: `gh auth status` | ||
| - Install: https://cli.github.com/ |
There was a problem hiding this comment.
Format bare URL as markdown link.
Line 25 contains a bare URL without markdown link syntax.
- **GitHub CLI (`gh`)** must be installed and authenticated
- Check: `gh auth status`
- - Install: https://cli.github.com/
+ - Install: [https://cli.github.com/](https://cli.github.com/)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Install: https://cli.github.com/ | |
| - Install: [https://cli.github.com/](https://cli.github.com/) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
25-25: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In plugins/github/README.md around line 25, the Install entry uses a bare URL;
replace it with a markdown link by wrapping the URL in square and round brackets
(e.g., [Install GitHub CLI](https://cli.github.com/) or simply
[https://cli.github.com/](https://cli.github.com/)) so the URL is rendered as a
clickable link in Markdown.
|
|
||
| Get a prioritized list of what to work on: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks.
Lines 34 and 46 have code blocks without language specification. This improves readability and syntax highlighting.
-```
+```bash
/github:what-next
-```
+```And:
-```
+```bash
/github:what-next --contributing docs/CONTRIBUTING.md
-```
+```Also applies to: 46-46
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
34-34: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In plugins/github/README.md around lines 34 and 46, the fenced code blocks are
missing language identifiers; update each opening triple-backtick to include the
language "bash" (i.e., change ``` to ```bash) for the code examples
"/github:what-next" and "/github:what-next --contributing docs/CONTRIBUTING.md"
so they render with bash syntax highlighting.
1 participant
What this PR does / why we need it:
Adds the
github:what-nextcommand to help developers identify what to focus on next by analyzing open PRs, assigned work, and milestone issues. It presents a prioritized list of actionable items based on common open-source contribution workflows.Which issue(s) this PR fixes:
n/a
Special notes for your reviewer:
Example output in a github repo I'm active on:
Example output in this
ai-helpersrepo (where I'm not active):Checklist:
Summary by CodeRabbit
/github:what-nextcommand to analyze PRs, issues, and milestones to identify and prioritize next work items.✏️ Tip: You can customize this high-level summary in your review settings.