Skip to content

Build Mkdocs site

experimental Static Badge

Usage

.github/workflows/pages.yml
name: Documentation

on:
  push:
    branches: ["main"]
    paths:
      - docs/**/*.md
      - docs/*.md
      - mkdocs.yml
      - .github/workflows/docs.yml
      - .github/workflows/mkdocs-build.yml

jobs:
  meta:
    uses: recaptime-dev/cicd-toolkit/.github/workflows/mkdocs-build.yml@main
    secrets: inherit
    with:
      # see options section below for supported options
      config: mkdocs.yml
      deploy-to: cf-pages
      cf-pages-project: recaptime-dev
    permissions:
      pages: write
      id-token: write
      contents: read

Options

Supported options still being ironed out

config

Required: Yes, but defaults to mkdocs.yml if left blank.

Path to Mkdocs config file to be used by the action container to run mkdocs build.

use-venv

Required: No, currently handled through Pipfile.lock detection.

When set to true or a Pipfile.lock is found within project root, the entrypoint script will create a Python virtual environment using the pipenv install --ignore-pipenv --deploy command.