Skip to content

Merge pull request #1207 from akselleirv/rename-repo #151

Merge pull request #1207 from akselleirv/rename-repo

Merge pull request #1207 from akselleirv/rename-repo #151

Workflow file for this run

name: docs
on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/docs.yaml'
- 'mkdocs.yml'
permissions:
contents: read # for actions/checkout to fetch code
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
- uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
with:
python-version: 3.x
- name: Install mkdocs
run: pip install mkdocs-material
- name: Generate docs artifacts
run: mkdocs build -d /tmp/docs
- uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
with:
ref: gh-pages
path: gh-pages
- name: Publish docs artifacts to gh-pages
run: |
cd gh-pages
shopt -s extglob
rm -rf !(index.yaml|LICENSE|*.tgz)
cp -R /tmp/docs/** .
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add -A
git commit -m "Publish docs from $GITHUB_SHA"
git push https://github.com/$GITHUB_REPOSITORY.git gh-pages