This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

Use correct branch as the basis for deploying the docs #10

	name: Docs

	on:
	pull_request:
	branches: ['main']
	paths:
	- 'docs/*/'
	- 'mkdocs.yml'

	push:
	branches: ['main']
	paths:
	- 'docs/*/'
	- 'mkdocs.yml'

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Allow one concurrent deployment
	concurrency:
	group: 'pages'
	cancel-in-progress: true

	jobs:
	build:
	runs-on: ubuntu-22.04
	steps:
	- name: Checkout code
	uses: actions/checkout@v3
	with:
	fetch-depth: 0

	- name: Setup Pages
	uses: actions/configure-pages@v3

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: 3.11
	cache: 'pip'

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	python -m pip install mkdocs==1.4.3 mkdocs-material==9.1.16 pymdown-extensions==10.0.1

	- name: Build site (_site directory name is used for Jekyll compatiblity)
	run: mkdocs build --config-file ./mkdocs.yml --site-dir ./_site
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v1

	deploy:
	needs: build
	if: github.ref == 'refs/heads/master'

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	# Deploy to the github-pages environment
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	runs-on: ubuntu-22.04
	steps:
	- name: Deploy Docs to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v2

Provide feedback