Skip to content

Formatting/general cleaning (#13) #24

Formatting/general cleaning (#13)

Formatting/general cleaning (#13) #24

Workflow file for this run

name: Publish Guides
on:
# Allow manual deployment
workflow_dispatch:
# Trigger when code is merged to `master` branch
push:
branches:
- master
jobs:
build:
name: Deploy Guides
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
REQUIREMENTS: .github/requirements.txt
- name: Upload GitHub Pages artifact
uses: actions/[email protected]
deploy:
# Add a dependency to the build job
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1