docs: Update "Getting Started" documentation #36
This file contains 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
name: Update documentation | |
# TODO: We may only want to do this for tagged releases in the future | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- docs/** | |
- mkdocs.yml | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
mkdocs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install mkdocs | |
run: | | |
pip install --user mkdocs | |
pip install --user mkdocs-material | |
pip install --user mkdocs-build-plantuml-plugin | |
- name: Deploy GitHub Pages | |
run: mkdocs build | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: site/ | |
# Deployment job, what was uploaded to artifact | |
deploy: | |
needs: mkdocs | |
runs-on: ubuntu-latest | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |