Skip to content

docs: update release guide with PyPA action #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 5, 2024
Merged

docs: update release guide with PyPA action #34

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c443e03
docs: update release guide with PyPA action
razvan Dec 5, 2024
12580dc
Update README.md
razvan Dec 5, 2024
04da7ed
review feedback
razvan Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,15 @@ Also see the `examples` folder.

## Release a new version

Update the version in:

* `src/beku/version.py`
* `README.md` : version and pip install command.

Update the CHANGELOG.
Commit and tag.
Build and publish:

```sh
rm -rf dist/
python -m build --sdist --wheel .
twine upload dist/*
```
A new release involves bumping the package version and publishing it to PyPI.
The easiest way to publish to PyPI is to allow the release GitHub action to do it for you.
This action is also the preferred way, as it will publish a verified package using PyPI attestations.

To release a new version follow the steps below:

1. Create a new Git branch. For example `release-1.2.3`.
2. Update the version string (`1.2.3`) in: `src/beku/version.py` and`README.md`.
3. Commit, push and create a PR.
4. After the PR is merged, switch to the `main` branch and update it by executing `git pull`.
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`.
6. Done!
Loading