[Docs] Add Docs to GH workflows (#1980)

* Add Docs to GH workflows

* Exclude docs/ from Docker build
pull/1982/head
Niko 2 years ago committed by GitHub
parent 91d1a044b5
commit 40ed3a3bd1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,5 +1,9 @@
name: Docker build
on: [pull_request]
on:
pull_request:
paths:
- '!mkdocs.yml'
- '!docs/**'
jobs:
docker:

@ -0,0 +1,42 @@
name: Docs
on: [push, pull_request, workflow_dispatch]
concurrency:
group: ${{ github.ref }}
cancel-in-progress: true
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- uses: actions/setup-python@v5.0.0
with:
python-version: 3.x
- uses: actions/cache@v3.3.2
with:
key: ${{ github.ref }}
path: .cache
- run: pip install -r docs/requirements.txt
- run: mkdocs build
deploy:
if: github.event_name == 'push' && contains(fromJson('["refs/heads/dev"]'), github.ref)
needs: build
name: Deploy docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
with:
fetch-depth: '0'
- uses: actions/setup-python@v5.0.0
with:
python-version: 3.x
- uses: actions/cache@v3.3.2
with:
key: ${{ github.ref }}
path: .cache
- run: pip install -r docs/requirements.txt
- run: mkdocs gh-deploy --force

@ -3,6 +3,9 @@ on:
push:
branches:
- dev
paths:
- '!mkdocs.yml'
- '!docs/**'
pull_request:
jobs:

@ -4,6 +4,9 @@ on:
push:
branches:
- dev
paths:
- '!mkdocs.yml'
- '!docs/**'
tags:
- '*'

@ -3,6 +3,9 @@ on:
push:
branches:
- dev
paths:
- '!mkdocs.yml'
- '!docs/**'
pull_request:
jobs:

@ -19,3 +19,7 @@ psutil>=3.1.0
python-ptrace>=0.8
six
unicorn>=1.0.0
mkdocs-material
mkdocs-git-committers-plugin-2
mkdocs-material-extensions
mkdocs-minify-plugin

Loading…
Cancel
Save