Skip to content

Merge pull request #3858 from uselagoon/pr-template #673

Merge pull request #3858 from uselagoon/pr-template

Merge pull request #3858 from uselagoon/pr-template #673

Workflow file for this run

name: Publish docs via GitHub Pages
on:
push:
branches:
- main
- mkdocs
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4
# - 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.GH_ACTION_PAT }}
# CONFIG_FILE: ./mkdocs.yml
# REQUIREMENTS: docs/requirements.txt
- name: Build
uses: Tiryoh/actions-mkdocs@v0
with:
mkdocs_version: 'latest' # option
#mkdocs_version: '1.1' # option
requirements: 'docs/requirements.txt' # option
configfile: './mkdocs.yml' # option
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site