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

Automatically publish docs to GitHub Pages #30

Closed
wants to merge 2 commits into from

Conversation

pniedzielski
Copy link
Collaborator

Closes: #27

It is useful to be able to dispatch a PyPI upload manually, without creating a
new GitHub release, in the case of transient GitHub Actions failures that are
not due to a problem in the release itself.  This patch enables the
`workflow_dispatch` trigger for our `wheels`, and explicitly allows
`upload_pypi` to run on `workflow_dispatch`, which allows us to manually and
intentionally call this workflow without making a new release.

Signed-off-by: Patrick M. Niedzielski <[email protected]>
Just as we upload to PyPI on new releases (as well as on manual dispatch of the
wheel-building workflow), we also want to build and upload documentation on new
releases.  We are moving to hosting the documentation locally on our own GitHub
pages, so we can do this automatically, rather than invoke a PR on the main
`blazingmq` repository.

This patch is a work-in-progress, and should not be merged yet.  We want to
ensure that the documentation is built correctly before we attempt to publish
it, so we run this on every build of the wheels, but also only publish to
GitHub Pages as a dry run.

Signed-off-by: Patrick M. Niedzielski <[email protected]>
@pniedzielski pniedzielski added documentation Improvements or additions to documentation enhancement New feature or request skip news No news entry is required labels Feb 8, 2024
@pniedzielski
Copy link
Collaborator Author

Splitting this PR into two separate ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request skip news No news entry is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build and host documentation on this repository's GH Pages
1 participant