CNTRLPLANE-2650: docs: add AI-assisted CI jobs documentation - #7598
Conversation
openshift-ci-robot
added
the
jira/valid-reference
openshift-ci
Bot
added
the
do-not-merge/work-in-progress
|
Skipping CI for Draft Pull Request. |
|
@bryan-cox: This pull request references CNTRLPLANE-2650 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
WalkthroughAdds a new AI-assisted CI jobs how-to page and navigation entry; substantially expands the reference/aggregated docs with many platform-specific guides, API schema additions, and new resource/type definitions. Changes
Estimated code review effort🎯 5 (Critical) | ⏱️ ~120 minutes Comment |
openshift-ci
Bot
added
do-not-merge/needs-area
area/documentation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bryan-cox The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
Bot
added
approved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/content/how-to/ci/ai-assisted-ci-jobs.md`:
- Around line 245-247: The fenced code block containing the command "/test
review-agent-single-pr" lacks a language specifier which triggers MD040; update
the fenced block around "/test review-agent-single-pr" to include an explicit
language (e.g., add "text" after the opening backticks) so the block reads like
```text ... ``` to satisfy markdownlint and improve readability.
| ``` | ||
| /test review-agent-single-pr | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced code block to satisfy MD040.
This avoids markdownlint warnings and improves readability.
✅ Suggested fix
-```
-/test review-agent-single-pr
-```
+```text
+/test review-agent-single-pr
+```📝 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.
| ``` | |
| /test review-agent-single-pr | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
245-245: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@docs/content/how-to/ci/ai-assisted-ci-jobs.md` around lines 245 - 247, The
fenced code block containing the command "/test review-agent-single-pr" lacks a
language specifier which triggers MD040; update the fenced block around "/test
review-agent-single-pr" to include an explicit language (e.g., add "text" after
the opening backticks) so the block reads like ```text ... ``` to satisfy
markdownlint and improve readability.
e69b9c6 to
66af119
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/content/reference/aggregated-docs.md`:
- Around line 9649-9650: Update the "Responsible Use" note so the referenced
phrase "Guidelines on Responsible Use of AI Code Assistants" becomes a markdown
link to the actual guidelines document; edit the block starting with the info
admonition title "Responsible Use" and replace the plain text with a
link-formatted reference (e.g., [Guidelines on Responsible Use of AI Code
Assistants](URL)) pointing to the canonical guidelines URL so users can click
through directly.
🧹 Nitpick comments (2)
docs/content/reference/aggregated-docs.md (2)
9697-9703: Use correct language identifier for JQL query.The code block is marked as
sql, but this is actually JQL (Jira Query Language), which has different syntax. Usejqlortextas the language identifier instead.📝 Suggested correction
-```sql +```jql project in (OCPBUGS, CNTRLPLANE) AND resolution = Unresolved AND status in (New, "To Do") AND labels = issue-for-agent AND labels != agent-processed</details> --- `9886-9888`: **Add language identifier to code block.** The code block is missing a language identifier, which affects rendering and consistency. <details> <summary>📝 Suggested fix</summary> ```diff -``` +```bash /test review-agent-single-pr</details> As per coding guidelines: Static analysis tool markdownlint-cli2 flagged this as MD040 violation (fenced-code-language). </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| !!! info "Responsible Use" | ||
| Please review the Guidelines on Responsible Use of AI Code Assistants before using these tools. |
There was a problem hiding this comment.
Add link to the referenced guidelines document.
The documentation references "Guidelines on Responsible Use of AI Code Assistants" but doesn't provide a link, making it difficult for users to access this important resource.
🔗 Suggested fix to add the link
If the guidelines document is available, please add a markdown link. For example:
!!! info "Responsible Use"
- Please review the Guidelines on Responsible Use of AI Code Assistants before using these tools.
+ Please review the [Guidelines on Responsible Use of AI Code Assistants](URL_TO_GUIDELINES) before using these tools.🤖 Prompt for AI Agents
In `@docs/content/reference/aggregated-docs.md` around lines 9649 - 9650, Update
the "Responsible Use" note so the referenced phrase "Guidelines on Responsible
Use of AI Code Assistants" becomes a markdown link to the actual guidelines
document; edit the block starting with the info admonition title "Responsible
Use" and replace the plain text with a link-formatted reference (e.g.,
[Guidelines on Responsible Use of AI Code Assistants](URL)) pointing to the
canonical guidelines URL so users can click through directly.
Add comprehensive documentation for the HyperShift AI-assisted Jira-solve and address-review Claude prow CI jobs to meet compliance requirements and provide user guidance. The documentation includes: - Human review disclaimer and responsible use guidelines - Jira Agent (periodic-jira-agent) workflow and data flow - Review Agent (periodic-review-agent) workflow and data flow - User guide for submitting issues and viewing output - Limitations, support, and monitoring information - Data flow diagrams using mermaid Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add detailed documentation for the review agent's comment analysis logic: - What counts as an unresolved review thread - Author authorization (openshift org, OWNERS file, approved bots) - Response rules (one response per feedback, code changes only when requested) - Update max agentic turns to 100 per PR Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
66af119 to
e21593f
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/content/reference/aggregated-docs.md`:
- Around line 9697-9703: The fenced SQL block and the `/test
review-agent-single-pr` command block violate markdownlint rules MD046/MD040;
fix by either converting the fenced SQL block (project in (OCPBUGS, CNTRLPLANE)
...) to an indented code block or wrap the fenced block with a local lint
disable/enable comment (<!-- markdownlint-disable MD046 MD040 --> ... <!--
markdownlint-enable MD046 MD040 -->) and add an explicit language for the
command block (e.g., ```bash) around `/test review-agent-single-pr`; apply the
same change pattern for the other occurrences referenced (the blocks at
9707-9736, 9816-9844, 9886-9888) so each fenced block has a language and any
MD046/MD040 violations are locally disabled/enabled.
| ```sql | ||
| project in (OCPBUGS, CNTRLPLANE) | ||
| AND resolution = Unresolved | ||
| AND status in (New, "To Do") | ||
| AND labels = issue-for-agent | ||
| AND labels != agent-processed | ||
| ``` |
There was a problem hiding this comment.
Fix markdownlint MD046/MD040 violations for code blocks.
markdownlint expects indented blocks (MD046) and a language for fenced blocks (MD040). Either convert these to indented blocks or wrap fenced blocks with a local markdownlint disable; additionally, add a language for the /test command block.
✅ Minimal fix example (language + lint disable)
+<!-- markdownlint-disable MD046 -->
```mermaid
flowchart TD
subgraph "Prow CI Environment"
A[Periodic Job Trigger<br/>Weekly Monday 8:30 UTC] --> B[Setup Step]
B --> C[Process Step]
...+
```diff
-```
+/```bash
/test review-agent-single-pr
</details>
Also applies to: 9707-9736, 9816-9844, 9886-9888
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>
9697-9697: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
In @docs/content/reference/aggregated-docs.md around lines 9697 - 9703, The
fenced SQL block and the /test review-agent-single-pr command block violate
markdownlint rules MD046/MD040; fix by either converting the fenced SQL block
(project in (OCPBUGS, CNTRLPLANE) ...) to an indented code block or wrap the
fenced block with a local lint disable/enable comment ( ... ) and add an
explicit language for the command block (e.g., ```bash) around /test review-agent-single-pr; apply the same change pattern for the other occurrences
referenced (the blocks at 9707-9736, 9816-9844, 9886-9888) so each fenced block
has a language and any MD046/MD040 violations are locally disabled/enabled.
</details>
<!-- fingerprinting:phantom:triton:eagle -->
<!-- This is an auto-generated comment by CodeRabbit -->
|
/lgtm |
|
/verified by rehearsing |
openshift-ci-robot
added
the
verified
|
@celebdor: This PR has been marked as verified by DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
@bryan-cox: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. I understand the commands that are listed here. |
3 participants
What this PR does / why we need it:
Adds comprehensive documentation for the HyperShift AI-assisted Jira-solve and address-review Claude prow CI jobs to meet compliance requirements and provide user guidance.
The documentation includes:
periodic-jira-agent) workflow and data flow diagramperiodic-review-agent) workflow and data flow diagramWhich issue(s) this PR fixes:
Fixes https://issues.redhat.com/browse/CNTRLPLANE-2650
Special notes for your reviewer:
Checklist:
🤖 Generated with Claude Code