Skip to content

fix: docs deployment#19

Merged
FBumann merged 1 commit intomainfrom
fix/ci
Jan 22, 2026
Merged

fix: docs deployment#19
FBumann merged 1 commit intomainfrom
fix/ci

Conversation

@FBumann
Copy link
Owner

@FBumann FBumann commented Jan 22, 2026

Summary by CodeRabbit

  • Chores
    • Integrated documentation building and deployment into the release workflow, ensuring documentation is automatically published to GitHub Pages when new releases are created.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This change relocates documentation deployment from the docs workflow to the release workflow. The docs workflow no longer triggers on GitHub releases or deploys to GitHub Pages, retaining only pull request builds. Documentation deployment now occurs as part of the release workflow.

Changes

Cohort / File(s) Summary
Docs workflow removal
.github/workflows/docs.yml
Removed release-triggered event, permissions block (contents: write), and GitHub Pages deployment step. Workflow now builds docs only for pull requests.
Release workflow enhancement
.github/workflows/release.yml
Added three sequential steps: install docs dependencies via uv sync --extra docs, build docs via uv run mkdocs build, and deploy site to GitHub Pages using peaceiris/actions-gh-pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Docs once danced when releases appeared,
Now they deploy when new builds are geared,
From workflows split to one unified flow,
The Pages now know just when to go! ✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@FBumann FBumann merged commit eadb35b into main Jan 22, 2026
8 of 9 checks passed
@FBumann FBumann deleted the fix/ci branch January 22, 2026 14:29
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