Skip to content

Add GitHub Actions workflow to auto-publish docs#838

Open
sachinnn99 wants to merge 1 commit intoNetflix:masterfrom
sachinnn99:feat/auto-publish-docs
Open

Add GitHub Actions workflow to auto-publish docs#838
sachinnn99 wants to merge 1 commit intoNetflix:masterfrom
sachinnn99:feat/auto-publish-docs

Conversation

@sachinnn99
Copy link
Copy Markdown

@sachinnn99 sachinnn99 commented Mar 28, 2026

Summary

  • Adds a GitHub Actions workflow (.github/workflows/docs-publish.yml) that automatically builds and deploys MkDocs documentation to GitHub Pages on pushes to master that modify docs/.
  • Uses mkdocs gh-deploy --force — the same command currently run manually.
  • Includes concurrency control to prevent race conditions on simultaneous deploys.

Closes #358

Details

  • Triggers only on docs/** path changes to avoid unnecessary runs
  • Uses github-actions[bot] identity for gh-pages commits
  • Installs the same 3 dependencies listed in docs/README.md: mkdocs, mkdocs-material, pymdown-extensions
  • Follows the official mkdocs-material publishing guide

Test plan

  • Verify workflow YAML syntax is valid
  • After merge, push a docs change to master and confirm the Actions tab shows the workflow running
  • Confirm https://netflix.github.io/mantis updates with the change

Automates MkDocs deployment to GitHub Pages on pushes to master
that modify the docs/ directory. Closes Netflix#358
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a CI Action that automatically publishes docs to the mantis docs page on commits to master

1 participant