Skip to content

Publish docs

Publish docs #394

Workflow file for this run

name: Publish docs
on:
push:
branches:
- main
workflow_dispatch:
repository_dispatch:
types: [publish-docs]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup config
uses: athackst/athackst.mkdocs@main
- name: Build and push docs to gh-pages
id: mkdocs
uses: athackst/mkdocs-simple-plugin@main
with:
push: false
- name: Upload artifact
uses: actions/upload-artifact@main
with:
name: 'github-pages'
path: ${{ steps.mkdocs.outputs.artifact }}
retention-days: 1
test:
runs-on: ubuntu-latest
needs: build
steps:
- name: Download artifact
uses: actions/download-artifact@v3
with:
name: github-pages
- name: Extract
run: |
mkdir _site
tar --directory _site -xvf "artifact.tar"
tree
- name: Test with htmlproofer
uses: athackst/htmlproofer-action@main
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: [build,test]
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2