Fix GitHub Pages deployment workflow

[Sefford]

🐞 Problem to Solve

The existing docs deployment relies on pushing generated output to gh-pages, which is brittle with the current GitHub Pages setup and can fail even when Dokka generation succeeds.

💡 Solution

• replaced the legacy gh-pages branch deployment with the supported GitHub Pages artifact flow
• added the required pages and id-token permissions
• split the workflow into separate build and deploy jobs
• added .nojekyll to the generated Dokka output before upload

🧪 Proof

Ran ./gradlew :lib:dokkaGenerate

---

✅ Checklist

• The PR includes a clear and descriptive title
• Related issue(s) are linked in the PR body
• The solution is explained thoroughly
• Tests or proofs are included

Summary by CodeRabbit

• Chores
  • Updated documentation deployment workflow with improved GitHub Pages integration.

[coderabbitai]

Warning

Rate limit exceeded

@Sefford has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 53 minutes and 21 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: af5af62d-1d33-431f-bcb4-7a3e3303c0ea

📥 Commits

Reviewing files that changed from the base of the PR and between 0d16242 and 1233a28.

📒 Files selected for processing (1)

• .github/workflows/deploy-docs.yml

📝 Walkthrough

Walkthrough

The workflow file is restructured to replace a third-party GitHub Pages action with the official GitHub Pages artifact upload and deployment pipeline. The build and deploy responsibilities are separated into distinct jobs, concurrency is added to serialize deployments, and permissions are explicitly scoped for Pages and token access.

Changes

GitHub Pages Workflow Refactoring

Layer / File(s)	Summary
Build and deploy job separation with official Pages actions .github/workflows/deploy-docs.yml	build-and-deploy job is split into separate build and deploy jobs. Concurrency configuration serializes Pages deployments. Permissions updated to contents: read, pages: write, and id-token: write. Build job disables Jekyll, configures Pages, uploads lib/build/docs as an artifact. Deploy job consumes the artifact and runs actions/deploy-pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Sefford/KISU#25: Updates the same deploy-docs workflow for Dokka doc generation and lib/build/docs artifact handling.

Poem

🐰 A workflow unfolds in rabbit time,
Two jobs now dance in perfect rhyme.
Pages official, no third-part friend,
Concurrency locked—deployment's blend! 📄✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Fix GitHub Pages deployment workflow' directly corresponds to the main change: restructuring the GitHub Pages deployment from legacy gh-pages branch push to the official Pages artifact flow.
Description check	✅ Passed	The description covers the required template sections: problem statement, solution with specific changes, and proof of testing, with all checklist items marked complete.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix-github-pages-deployment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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/deploy-docs.yml:
- Around line 40-49: The uploaded Pages artifact is excluding the .nojekyll file
because actions/upload-pages-artifact@v4 defaults include-hidden-files to false;
update the Upload Pages artifact step (the action usage of
actions/upload-pages-artifact@v4) to set include-hidden-files: true so the
generated .nojekyll file is included in the artifact and Jekyll processing is
disabled as intended.

🪄 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: Pro Plus

Run ID: a54f2479-0164-4cde-8810-fde6c9fc736c

📥 Commits

Reviewing files that changed from the base of the PR and between 9c09f51 and 0d16242.

📒 Files selected for processing (1)

• .github/workflows/deploy-docs.yml