Add GitHub Pages deployment workflow#137
Merged
Merged
Conversation
- Add deploy_docs_github_pages.yml using GitHub Actions Pages API (build + deploy jobs) - Rename deploy_docs.yml to deploy_docs_naoj.yml to keep NAOJ server deployment - Update site_url in mkdocs.yml to https://subaru-pfs.github.io/ets_target_database/ - Add /_site to .gitignore Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds automated documentation deployment to GitHub Pages while keeping the existing NAOJ self-hosted deployment, and updates MkDocs configuration/output ignore patterns to match.
Changes:
- Added a new GitHub Actions workflow to build and deploy MkDocs docs to GitHub Pages on pushes to
mainand via manual trigger. - Preserved the NAOJ deployment by introducing
deploy_docs_naoj.ymlfor the self-hosted runner deployment. - Updated MkDocs
site_urlfor the GitHub Pages URL and added/_siteto.gitignore.
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
mkdocs.yml |
Updates site_url to the GitHub Pages project URL. |
.gitignore |
Ignores _site build output directory used by the new Pages workflow. |
.github/workflows/deploy_docs_naoj.yml |
Adds/renames the NAOJ self-hosted deployment workflow. |
.github/workflows/deploy_docs_github_pages.yml |
Introduces GitHub Pages build + deploy workflow using Pages actions and uv-based MkDocs build. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.github/workflows/deploy_docs_github_pages.ymlto deploy MkDocs documentation to GitHub Pages on every push tomain(and via manual trigger)deploy_docs.yml→deploy_docs_naoj.ymlto preserve the existing NAOJ server deploymentsite_urlinmkdocs.ymltohttps://subaru-pfs.github.io/ets_target_database//_siteto.gitignoreWorkflow details
The new workflow uses the GitHub Actions Pages API (build + deploy jobs) with minimal permissions (
pages: write,id-token: write). System dependencies formkdocs-material[imaging](libcairo2-dev,libpango1.0-dev) are installed to support thesocialplugin.Test plan
🤖 Generated with Claude Code