Skip to content

ci: Add GitHub Pages documentation workflow#26

Merged
rdmueller merged 3 commits intomainfrom
feature/ci-documentation
Jan 21, 2026
Merged

ci: Add GitHub Pages documentation workflow#26
rdmueller merged 3 commits intomainfrom
feature/ci-documentation

Conversation

@raifdmueller
Copy link
Collaborator

Summary

Adds automated documentation build and deployment via GitHub Actions using docToolchain.

Changes

  • Add .github/workflows/gh-pages.yml workflow
  • Add build/ to .gitignore

Workflow Features

  • Build: Runs on every PR and push to main
  • Deploy: Only deploys to GitHub Pages on push to main
  • Uses docToolchain generateSite to build arc42 documentation
  • Uses modern GitHub Pages deployment (actions/deploy-pages@v4)
  • Requires Java 17 (Temurin distribution)

Prerequisites

After merging, enable GitHub Pages in repository settings:

  1. Go to Settings > Pages
  2. Source: "GitHub Actions"

Tested Locally

$ ./dtcw generateSite
BUILD SUCCESSFUL in 1m 32s
3 actionable tasks: 3 executed

Test plan

  • Build works locally with ./dtcw generateSite
  • Output generated in build/microsite/output/
  • GitHub Actions workflow runs successfully
  • Documentation accessible via GitHub Pages URL

Closes #24

🤖 Generated with Claude Code

- 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>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

rdmueller and others added 2 commits January 21, 2026 09:47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@rdmueller rdmueller merged commit 35fe888 into main Jan 21, 2026
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.

CI: Documentation Build with docToolchain and GitHub Pages Deployment

3 participants