Skip to content

Deployment docs #66

Open
Open

Description

@lovelydinosaur

Here's a GitHub workflow that'll automatically deploy to github pages...

name: Documentation

on:
  push:
    branches:
        - main  # Or whatever the default branch is.

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/configure-pages@v5
      - uses: actions/checkout@v5
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - run: pip install --pre mkdocs  # We really need to get this onto a regular install
      - run: mkdocs build
      - uses: actions/upload-pages-artifact@v4
        with:
          path: site
      - uses: actions/deploy-pages@v4
        id: deployment

(Is there anything we can tidy up and make less complex there?)

We can also document using ghp-import for manual deploys.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions