Skip to content

Merge pull request #269 from Nitjsefnie-OSC/docs/110-provider-api-key… #25

Merge pull request #269 from Nitjsefnie-OSC/docs/110-provider-api-key…

Merge pull request #269 from Nitjsefnie-OSC/docs/110-provider-api-key… #25

Workflow file for this run

name: Deploy documentation
on:
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/deploy.yml"
# Allow manual runs from the Actions tab
workflow_dispatch:
# Grant the GITHUB_TOKEN the permissions required to deploy to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment; cancel in-progress runs on new pushes
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
cache: pip
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install "mkdocs>=1.6" mkdocs-material
- name: Configure Pages
id: pages
uses: actions/configure-pages@v5
- name: Build documentation
run: mkdocs build --strict --site-dir site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4