From fa0900f84022e28ac1c57f19dbdca41645412607 Mon Sep 17 00:00:00 2001 From: Cyrill Raccaud Date: Sun, 15 Sep 2024 11:33:25 +0200 Subject: [PATCH] add release instructions to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3d0a54c..9c955f2 100755 --- a/README.md +++ b/README.md @@ -149,6 +149,12 @@ Following VSCode integrations may be helpful: * [mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) * [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) +### Releasing + +It is only possible to release a _final version_ on the `master` branch. For it to pass the gates of the `publish` workflow, it must have the same version in the `tag`, the `setup.cfg`, the `bring_api/__init__.py` and an entry in the `CHANGELOG.md` file. + +To release a prerelease version, no changelog entry is required, but it can only happen on a feature branch (**not** `master` branch). Also, prerelease versions are marked as such in the github release page. + ## Credits This is a detached fork from the repo , which does not seem to get evolved anymore.