Release operations
This repository now has three distinct automation paths:
wheels.yml: validates wheel and sdist builds on pull requests and pushespublish.yml: builds release artifacts from a Git tag and publishes to PyPIpages.yml: publishes the documentation site to GitHub Pages
One-time PyPI setup
Before the first release, configure PyPI Trusted Publishing for project
pycddp.
On PyPI:
- Create the project if it does not exist yet.
- Add a trusted publisher for GitHub Actions.
- Set owner to
astomodynamics. - Set repository to
cddp-cpp. - Set workflow to
.github/workflows/publish.yml. - Set environment name to
pypi.
After that, pushing a tag like v0.1.0 will publish the matching artifacts.
One-time GitHub Pages setup
On GitHub:
- Open repository settings.
- Open Pages.
- Set the source to
GitHub Actions.
After that, pushes to master that touch the docs or mkdocs.yml will deploy
the site.
Release steps
- Update package version if needed.
- Merge the release changes to
master. - Create and push a tag:
git tag v0.1.0
git push origin v0.1.0
- Verify the
publish.ymlworkflow succeeds. - Confirm the release appears on PyPI and the docs site is current.