You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
@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?
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?).
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:
The text was updated successfully, but these errors were encountered: