Skip to content

CI/CD

GitHub Actions

The project uses GitHub Actions for: - Building and testing - Release deployment - Documentation publishing

See .github/workflows/ for workflow definitions.

Documentation Deployment

The documentation is automatically deployed to GitHub Pages using the deploy-docs.yml workflow.

Initial Setup

To enable documentation deployment, you need to configure GitHub Pages in the repository settings:

  1. Go to Settings → Pages in the repository
  2. Under Build and deployment, set:
  3. Source: GitHub Actions
  4. Save the settings

The workflow will automatically deploy documentation when: - Changes are pushed to the main or production branches that affect: - Files in the docs/ directory - The mkdocs.yml configuration file - The workflow file itself - The workflow is manually triggered via workflow_dispatch

Workflow Details

The deployment workflow consists of two jobs:

  1. Build Job:
  2. Checks out the repository
  3. Sets up Python
  4. Installs MkDocs and dependencies
  5. Builds the documentation site

  6. Uploads the built site as an artifact

  7. Deploy Job:

  8. Downloads the artifact from the build job
  9. Deploys to GitHub Pages using the official GitHub Pages action
  10. Provides the deployed site URL in the workflow output

The documentation will be available at: https://shelbeely.github.io/OpenTransition/