melissawm / sphinx-tags

A tiny Sphinx extension that implements blog-style tags for documentation.

https://sphinx-tags.readthedocs.io/en/latest/

MIT License

44 stars 11 forks source link

Automate releases based on git tags #73

Closed JWCook closed 10 months ago

JWCook commented 10 months ago

Closes #72

Changes

Pushing a git tag triggers the workflow in .github/workflows/release.yml
This builds the package wheel and sdist, and publishes them to PyPI using GitHub as a trusted publisher.
It also creates a new GitHub release with placeholder text linking to the changelog. You can customize this and other settings documented here.

PyPI setup

To enable this on the PyPI end, you can go to Manage -> Publishing -> Add a new publisher.

owner/repository: melissawm/sphinx-tags
workflow name: release.yml
environment name: None

More details in the PyPI docs here.

Notes

You can still publish releases manually if you need to. If you do that and then push a new tag, the action will just fail because a release with the specified version already exists. It shouldn't cause any problems.
Feel free to ping me in the future if you have any problems with this, or want help updating this workflow to do something different.

JWCook commented 10 months ago

Ah, sorry, looks like I forgot to put that setting under with. I'll fix that shortly.