File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -65,17 +65,15 @@ Also see the `examples` folder.
6565
6666## Release a new version
6767
68- Update the version in:
69-
70- * ` src/beku/version.py `
71- * ` README.md ` : version and pip install command.
72-
73- Update the CHANGELOG.
74- Commit and tag.
75- Build and publish:
76-
77- ``` sh
78- rm -rf dist/
79- python -m build --sdist --wheel .
80- twine upload dist/*
81- ```
68+ A new release involves bumping the package version and publishing it to PyPI.
69+ The easiest way to publish to PyPI is to allow the release GitHub action to do it for you.
70+ This action is also the preferred way, as it will publish a verified package using PyPI attestations.
71+
72+ To release a new version follow the steps below:
73+
74+ 1 . Create a new Git branch. For example ` release-1.2.3 ` .
75+ 2 . Update the version string (` 1.2.3 ` ) in: ` src/beku/version.py ` and` README.md ` .
76+ 3 . Commit, push and create a PR.
77+ 4 . After the PR is merged, switch to the ` main ` branch and update it by executing ` git pull ` .
78+ 5 . On the ` main ` branch, create and push the release tag. For example: ` git tag 1.2.3 -m 1.2.3 && git push origin 1.2.3 ` .
79+ 6 . Done!
You can’t perform that action at this time.
0 commit comments