Conversation
Contributors no longer need to run `make update` to regenerate docs. CI handles doc generation on merge to main and auto-merges the resulting PR when only docs/index.html is changed. A new `make docs` target is available for local preview. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: stbenjam 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
the
approved
When multiple plugin PRs merge to main in quick succession, the older workflow run could overwrite newer docs. Cancel in-progress runs so only the latest commit's docs are generated. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The rule file was deleted but its registration in .skillsaw.yaml remained, causing the linter to crash with FileNotFoundError. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThis PR shifts documentation regeneration to CI: the update-docs workflow now triggers on marketplace metadata changes, exposes the created PR id and auto-merges docs-only PRs; the local Skillsaw docs-freshness rule is removed; Makefile and contributor docs are updated to reflect CI-managed doc regeneration. ChangesShift Documentation Regeneration to CI Automation
Sequence DiagramsequenceDiagram
participant GitHub as GitHub Trigger
participant WF as update-docs Workflow
participant CLI as GitHub CLI
GitHub->>WF: push affecting marketplace.json or docs
WF->>WF: create PR (id: create-pr)
WF->>CLI: gh pr diff PR_NUMBER --name-only
CLI-->>WF: changed files list
alt Only docs/index.html changed
WF->>CLI: gh pr merge PR_NUMBER --auto --squash
CLI-->>GitHub: PR merged
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 10✅ Passed checks (10 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
3 tasks
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/workflows/update-docs.yml (1)
65-66: ⚡ Quick winAvoid in-
runexpression interpolation for readability; “template-injection” risk is unclearAt lines 65-66,
${{ steps.create-pr.outputs.pull-request-number }}is evaluated by GitHub Actions before the shell runs, andpeter-evans/create-pull-requestreturnspull-request-numberas a (string) PR number; the step is already gated byif: steps.create-pr.outputs.pull-request-number. The main improvement here is optional hardening/readability: pass it viaenvand add a numeric guard before using it withgh pr diff/merge.🔒 Suggested hardening
- name: Enable auto-merge if only docs changed if: steps.create-pr.outputs.pull-request-number env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PR_NUMBER: ${{ steps.create-pr.outputs.pull-request-number }} run: | - PR_NUMBER="${{ steps.create-pr.outputs.pull-request-number }}" + [[ "$PR_NUMBER" =~ ^[0-9]+$ ]] || { echo "Invalid PR number"; exit 1; } FILES_CHANGED=$(gh pr diff "$PR_NUMBER" --name-only) if [ "$FILES_CHANGED" = "docs/index.html" ]; then gh pr merge "$PR_NUMBER" --auto --squash fi🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/update-docs.yml around lines 65 - 66, The PR_NUMBER interpolation should be moved out of the inline run string and passed via environment (set PR_NUMBER: ${{ steps.create-pr.outputs.pull-request-number }} in the step env) and then guard its usage before calling gh pr diff: ensure PR_NUMBER is non-empty and numeric (e.g., test -n "$PR_NUMBER" && [[ "$PR_NUMBER" =~ ^[0-9]+$ ]]) before running FILES_CHANGED=$(gh pr diff "$PR_NUMBER" --name-only); update the step that sets FILES_CHANGED and any subsequent gh pr merge/diff invocations to use the env PR_NUMBER variable with this numeric guard to improve readability and hardening.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 50-53: The doc currently omits running the repository sync step
after version bumps; update the CONTRIBUTING.md steps to re-add "Run `make
update` after bumping the version in plugin.json" (placed between the version
bump step and `make lint`) and note that this syncs marketplace.json so
marketplace data stays current; reference plugin.json, make update, make lint,
and marketplace.json in the guidance so contributors run the update step after
changing plugin code.
---
Nitpick comments:
In @.github/workflows/update-docs.yml:
- Around line 65-66: The PR_NUMBER interpolation should be moved out of the
inline run string and passed via environment (set PR_NUMBER: ${{
steps.create-pr.outputs.pull-request-number }} in the step env) and then guard
its usage before calling gh pr diff: ensure PR_NUMBER is non-empty and numeric
(e.g., test -n "$PR_NUMBER" && [[ "$PR_NUMBER" =~ ^[0-9]+$ ]]) before running
FILES_CHANGED=$(gh pr diff "$PR_NUMBER" --name-only); update the step that sets
FILES_CHANGED and any subsequent gh pr merge/diff invocations to use the env
PR_NUMBER variable with this numeric guard to improve readability and hardening.
🪄 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: Enterprise
Run ID: 4ad9e20b-444d-45df-8d33-7fa51c36d0c8
📒 Files selected for processing (6)
.github/workflows/update-docs.yml.skillsaw.yaml.skillsaw/plugindocs_rule.pyAGENTS.mdCONTRIBUTING.mdMakefile
💤 Files with no reviewable changes (2)
- .skillsaw.yaml
- .skillsaw/plugindocs_rule.py
- Move PR_NUMBER to env var with numeric guard instead of inline expression interpolation - Re-add make update step to contributor docs (still needed for marketplace version sync, just not for docs generation) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Member
Author
|
/hold It might make sense to use the gh-pages branch so we don't have to build the image on those update PR's. |
openshift-ci
Bot
added
the
do-not-merge/hold
Contributor
|
Actionable comments posted: 0 |
Member
Author
|
Defer this, the JSON structure is fine for now as a way to mitigate diff conflicts |
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.
See: #487 (comment)
Summary
mainand enables auto-merge when the only file changed isdocs/index.htmlplugins-doc-up-to-datelint rule so contributors no longer need to runmake updatefor docsmake docstarget for optional local previewPrerequisite
Enable "Allow auto-merge" in repo Settings > General > Pull Requests.
Test plan
mainand verify the docs PR is created with auto-merge enabledmake lintpasses withoutdocs/being in syncmake docsgenerates docs locally🤖 Generated with Claude Code
Summary by CodeRabbit