Skip to content

Commit

Permalink
GHa workflow for mkdocs and GH pages
Browse files Browse the repository at this point in the history
  • Loading branch information
thlava-cesnet committed Aug 22, 2024
1 parent 8527936 commit f5ba8a0
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/mkdocs_ghpages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Run mkdocs and deploy to GitHub Pages

on:
# push:
# branches: ["master"]
workflow_dispatch:

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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
mkdocs:
runs-on: ubuntu-latest
env:
PYTHON_VERSION: "3.10"
steps:
- name: Set up Python ${{ env.PYTHON_VERSION }}
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}

- name: Checkout
uses: actions/checkout@v4

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

- name: Run mkdocs
id: run-mkdocs
run: |
python -m venv .venv
. .venv/bin/activate
pip install -e .
mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "site/"

deploy-pages:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: mkdocs
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit f5ba8a0

Please sign in to comment.