ci: Add GitHub Pages documentation workflow#26
Merged
Conversation
- Add .github/workflows/gh-pages.yml for documentation deployment - Uses docToolchain generateSite to build documentation - Deploys to GitHub Pages on push to main - Build runs on all PRs for validation - Uses modern GitHub Pages deployment with actions/deploy-pages - Add build/ to .gitignore Closes #24 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds automated documentation building and deployment using GitHub Actions and docToolchain. The workflow builds arc42 documentation on every PR and push to main, but only deploys to GitHub Pages when changes are pushed to the main branch.
Changes:
- Adds GitHub Actions workflow for building and deploying documentation via GitHub Pages
- Excludes
build/directory from version control
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.gitignore |
Adds build/ directory to ignore list for docToolchain build output |
.github/workflows/gh-pages.yml |
Implements automated documentation build/deploy workflow with Java 17 and docToolchain |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Adds automated documentation build and deployment via GitHub Actions using docToolchain.
Changes
.github/workflows/gh-pages.ymlworkflowbuild/to.gitignoreWorkflow Features
docToolchain generateSiteto build arc42 documentationactions/deploy-pages@v4)Prerequisites
After merging, enable GitHub Pages in repository settings:
Tested Locally
Test plan
./dtcw generateSitebuild/microsite/output/Closes #24
🤖 Generated with Claude Code