dtiesling / flask-muck

🧹 Flask REST framework for generating CRUD APIs and OpenAPI specs in the SQLAlchemy, Marshmallow/Pydantic application stack.
https://dtiesling.github.io/flask-muck/
MIT License
163 stars 7 forks source link

ci: add release please #27

Closed bt-macole closed 10 months ago

bt-macole commented 10 months ago

this introduces auto changelog, updating version via conventional commits, and modifies the publish action to use pyproject.toml for the current version.

🚨 this assumes a secret exists for a PAT called RELEASE_PLEASE_TOKEN in order for release-please to trigger the publish action a token other than default GITHUB_TOKEN must be used.

chore: update the version in pyproject.toml to be 'statically' typed since it is managed by release-please. chore: update the project name to lower case so release-please can find src/{package_name}/__init__.py.

this means that there is no reason to update hatch in the publish phase, since it will read in the pyproject version. VERSION was renamed to __version__ to work with release-please and hatch--it is likely safe to remove __version__ from __init__.py as well.

to manually override the initial release to match the latest published pypi package you can use Release-As: 0.2.0 as a footer in a PR commit.

Release-As: 0.2.0