Adjust how docs ci does the checks, also include checks in PRs - #112
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe documentation workflow now validates relevant pull requests, scopes concurrency by ChangesDocumentation workflow
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.github/workflows/docs.yml (1)
59-59: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick winPin every
uses:entry to a full-length commit SHA.Replace the six remaining mutable tags, including
lycheeverse/lychee-action@v2, which receivesGITHUB_TOKEN, with immutable 40-character commit SHAs.🤖 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/docs.yml at line 59, Update all six remaining uses entries in the workflow, including lycheeverse/lychee-action@v2, to reference immutable full-length 40-character commit SHAs instead of mutable tags. Preserve each action and its existing configuration while ensuring every uses value is pinned.
🤖 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 @.github/workflows/docs.yml:
- Line 88: Update the workflow job permissions so build retains only contents:
read, while deploy receives pages: write and id-token: write. Keep the existing
deployment condition unchanged.
- Line 34: Update the actions/checkout step in the docs workflow to set
persist-credentials to false, ensuring repository-controlled validation commands
cannot access the persisted GITHUB_TOKEN through Git configuration.
---
Nitpick comments:
In @.github/workflows/docs.yml:
- Line 59: Update all six remaining uses entries in the workflow, including
lycheeverse/lychee-action@v2, to reference immutable full-length 40-character
commit SHAs instead of mutable tags. Preserve each action and its existing
configuration while ensuring every uses value is pinned.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 173a7be0-001a-4130-9593-a0c46301f485
📒 Files selected for processing (1)
.github/workflows/docs.yml
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 @.github/workflows/docs.yml:
- Around line 33-34: Move persist-credentials from the step-level keys into the
with block of the actions/checkout step, preserving its false value so the
checkout action receives it as an input.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: a017c43e-706c-4445-89f7-35a118792979
📒 Files selected for processing (1)
.github/workflows/docs.yml
863b752 to
5c4c804
Compare
Description
Docs publish on merge kept failing as checks weren't set to the correct root.
Related Issues
Testing
Type of Change
expected)
Summary by CodeRabbit
Documentation
Chores