Skip to content

Add coverage (#17)

Add coverage (#17) #5

Workflow file for this run

name: deploy-mkdocs
on:
push:
branches:
- develop # Triggers deployment on push to the main branch
jobs:
mkdocs-deploy:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/develop' # Only deployed for the develop branch
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.9
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
mkdocs-bibtex-
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material==8.1.1 pymdown-extensions mkdocs-click
- name: Build MKDocs Documentation
run: mkdocs build --verbose
- name: Deploy MKDocs to GitHub Pages
run: |
if [ -n "$GITHUB_TOKEN" ]; then
mkdocs gh-deploy --force
else
echo "Set the GH_PAGES_TOKEN secret in your repository for deploying to GitHub Pages."
exit 1
fi
env:
GITHUB_TOKEN: ${{ secrets.GH_PAGES_TOKEN }}