Skip to content

ci: deploy mkdocs via GitHub Actions#14

Merged
lesnik512 merged 7 commits into
mainfrom
feat/docs-github-actions
Jun 9, 2026
Merged

ci: deploy mkdocs via GitHub Actions#14
lesnik512 merged 7 commits into
mainfrom
feat/docs-github-actions

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

  • Adds a Deploy Docs workflow that auto-deploys mkdocs to gh-pages on push to main when docs/** or mkdocs.yml changes.
  • Adds a docs-deploy recipe to Justfile (uvx mkdocs gh-deploy --force), mirroring modern-di.
  • Configures the custom subdomain semvertag.modern-python.org via site_url in mkdocs.yml and docs/CNAME.
  • Bumps action pins across ci.yml, publish.yml, semvertag.yml, tag-major.yml to match modern-di parity: checkout@v6, setup-just@v4, setup-uv@v8.2.0.

Spec: planning/specs/2026-06-09-mkdocs-github-actions-design.md

Test plan

  • CI lint job passes under bumped action pins
  • CI pytest matrix passes under bumped action pins
  • action-smoke job passes under checkout@v6 (this is the one job where the bump could surface a difference — composite action exercised via uses: ./)
  • After merge: trigger Deploy Docs via workflow_dispatch from the Actions UI — workflow succeeds, creates gh-pages branch
  • After merge: enable GitHub Pages on the gh-pages branch in repo Settings → Pages
  • After merge: configure DNS for semvertag.modern-python.org (CNAME → modern-python.github.io.) and verify the site serves

🤖 Generated with Claude Code

lesnik512 and others added 7 commits June 9, 2026 14:01
Mirrors modern-di's docs-deploy setup: Justfile recipe, docs.yml
workflow on push-to-main, custom subdomain via site_url + CNAME,
plus an action-version bump pass across existing workflows.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Five-task plan: Justfile recipe, docs.yml workflow, mkdocs.yml +
CNAME for custom subdomain, mechanical action-pin bump across four
existing workflows, then verify + PR.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Every other recipe in this Justfile and modern-di's docs-deploy
use 4 spaces; the tab was an inconsistency, not a deliberate choice.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@lesnik512 lesnik512 self-assigned this Jun 9, 2026
@lesnik512 lesnik512 merged commit a2cc114 into main Jun 9, 2026
6 checks passed
@lesnik512 lesnik512 deleted the feat/docs-github-actions branch June 9, 2026 12:59
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