mkdocs-deploy.md

Deploy MkDocs

Deploy MkDocs documentation to GitHub Pages with versioning support

Usage

- uses: serapeum-org/github-actions/actions/mkdocs-deploy@mkdocs/v1
  with:
    trigger: # required
    package-manager: 'uv'
    python-version: '3.12'
    install-groups: 'groups: docs'
    deploy-token: # required
    release-tag: ''
    mike-alias: 'latest'
    notebooks-path: ''
    notebooks-exclude: ''
    notebooks-continue-on-error: 'false'

Inputs

Input	Description	Required	Default
trigger	Deployment trigger type (pull_request, main, release)	Yes	-
package-manager	Package manager to use (pip, uv, pixi)	No	uv
package-manager-version	Version of the uv/pixi package manager to install (forwarded to its version input); ignored for pip.	No	latest
python-version	Python version to install	No	3.12
install-groups	Dependency groups to install	No	groups: docs
deploy-token	GitHub token for deployment	Yes	-
release-tag	Release tag version (for release trigger)	No	-
mike-alias	Mike alias for releases (e.g., latest)	No	latest
notebooks-path	Root directory of Jupyter notebooks to execute and cache before the mkdocs build. Requires jupyter, nbconvert, ipykernel, mkdocs-jupyter in install-groups, and a src-layout project (src/**/*.py, pyproject.toml at root). Empty = skip. See mkdocs-deploy guide.	No	'' (skip)
notebooks-exclude	Newline- or comma-separated glob patterns (matched against each notebook's path relative to notebooks-path, e.g. dask/*.ipynb, **/stac-cloud-*.ipynb) identifying notebooks to skip executing. A leading **/ also matches at the root level. Excluded notebooks are rendered without fresh execution. Mirrors pytest's --ignore-glob.	No	'' (exclude nothing)
notebooks-continue-on-error	When true, a non-excluded notebook that fails to execute is downgraded to a warning and the remaining notebooks still run, instead of aborting the prepare step. The failing notebook is not cached.	No	false