Skip to content

Automate docs deployment #9759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2025

Conversation

browniebroke
Copy link
Member

@browniebroke browniebroke commented Aug 9, 2025

Description

Automatcially deployes the docs to GH pages each time a push to master changes the content of the docs, theme, config or dependencies.

Repo with a minimal setup https://github.com/browniebroke/poc-mkdocks-gh-deploy-gh-actions

Deployed https://browniebroke.github.io/poc-mkdocks-gh-deploy-gh-actions/

Right now, maintainers have to remember to run mkdocs gh-deploy manually.

On pushes to master, when the content of the docs or its config chnages
@browniebroke browniebroke added this to the 3.16 milestone Aug 9, 2025
Copy link
Collaborator

@peterthomassen peterthomassen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the code lgtm, although I have not tested it.

@auvipy auvipy merged commit 317ca82 into encode:master Aug 10, 2025
7 checks passed
@browniebroke browniebroke deleted the ci/automate-docs-deployment branch August 15, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants