Skip to content

Adjust how docs ci does the checks, also include checks in PRs - #112

Merged
Ashex merged 3 commits into
mainfrom
fix/docs-link-check
Jul 31, 2026
Merged

Adjust how docs ci does the checks, also include checks in PRs#112
Ashex merged 3 commits into
mainfrom
fix/docs-link-check

Conversation

@Ashex

@Ashex Ashex commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Description

Docs publish on merge kept failing as checks weren't set to the correct root.

Related Issues

Testing

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • Documentation update
  • Performance improvement
  • Code refactoring
  • Build/CI changes
  • Test improvements

Summary by CodeRabbit

  • Documentation

    • Improved Markdown formatting and broken-link checks.
    • Extensionless documentation links are now validated more accurately.
    • Documentation updates in pull requests are checked automatically.
  • Chores

    • Improved the safety and reliability of documentation workflows.
    • Reduced unnecessary publishing and deployment actions during pull request validation.
    • Strengthened workflow permissions and credential handling.
    • Updated documentation validation tooling for more consistent results.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: df523623-fc42-4660-a5e4-5a0561a45ac7

📥 Commits

Reviewing files that changed from the base of the PR and between 863b752 and 5c4c804.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/docs.yml

📝 Walkthrough

Walkthrough

The documentation workflow now validates relevant pull requests, scopes concurrency by github.ref, pins actions, resolves extensionless Markdown links, and skips Pages deployment operations for pull-request events.

Changes

Documentation workflow

Layer / File(s) Summary
Workflow entry and validation
.github/workflows/docs.yml
The workflow adds pull-request triggers for documentation changes, scopes concurrency by github.ref, disables checkout credentials, pins actions, and configures Lychee with documentation-root link resolution.
Pages deployment gating
.github/workflows/docs.yml
The workflow limits Pages configuration, artifact upload, and deployment to non-pull-request events. It grants Pages and OIDC write permissions at the deployment-job level.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation CI updates and the addition of checks for pull requests.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-link-check

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
.github/workflows/docs.yml (1)

59-59: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Pin every uses: entry to a full-length commit SHA.

Replace the six remaining mutable tags, including lycheeverse/lychee-action@v2, which receives GITHUB_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

📥 Commits

Reviewing files that changed from the base of the PR and between bbc2f4f and f2cdafa.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml

Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/docs.yml

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between f2cdafa and 224879a.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml

Comment thread .github/workflows/docs.yml Outdated
@Ashex
Ashex force-pushed the fix/docs-link-check branch from 863b752 to 5c4c804 Compare July 31, 2026 20:32
@Ashex
Ashex merged commit 81bb2bb into main Jul 31, 2026
4 checks passed
@Ashex
Ashex deleted the fix/docs-link-check branch July 31, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant