Skip to content
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

Automate docs deployment, document the process #3642

Open
pawamoy opened this issue Apr 15, 2024 · 4 comments
Open

Automate docs deployment, document the process #3642

pawamoy opened this issue Apr 15, 2024 · 4 comments

Comments

@pawamoy
Copy link
Contributor

pawamoy commented Apr 15, 2024

Currently, new releases are pushed to PyPI through GitHub Actions, using the official pypa/gh-action-pypi-publish action. However documentation is still deployed from local environments. We would like to automate the deployment of documentation through GitHub Actions too, as it's usually what works best for teams of maintainers/contributors, allowing anyone to quickly release docs enhancements without setting up a local environment and without requiring specific privileges.

This is a follow-up of #814, which is a bit dated and only shows comments about Travis CI.

In the process of automating docs deployments, we should also document this process (as well as how new releases are published).

Related issues:

@humitos
Copy link
Contributor

humitos commented Apr 15, 2024

However documentation is still deployed from local environments. We would like to automate the deployment of documentation through GitHub Actions too

In case you are also considering using Read the Docs for this, I can help you with that. Let me know.

@pawamoy
Copy link
Contributor Author

pawamoy commented Apr 15, 2024

Thanks for offering your help @humitos, we'll definitely consider this interesting option 👍

@kchr
Copy link

kchr commented Jun 1, 2024

@pawamoy Hi, I was about to prepare a PR for this but noticed you seem to be using commits on the gh-pages branch as a publishing source (deployment trigger) for your Github Pages at the moment:

Just to clarify, am I right to assume that you want to migrate to a fully automated workflow triggered by tag events in your default branch (master) when releasing a new version of the project?

@pawamoy
Copy link
Contributor Author

pawamoy commented Jun 7, 2024

Hi @kchr, thanks for helping!

The workflow you mention is native to GitHub Actions. The commit you reference was made through mkdocs gh-deploy. Currently, docs are indeed deployed using mkdocs gh-deploy locally.

We do want to build and deploy docs when releasing (pushing a tag). Ideally, we would also build and deploy previews in pull requests. Not sure how to do that yet (I've seen people use Smokeshow I believe?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants