From c443e0359694aecf54e3e7a37904e8ad7537b1fd Mon Sep 17 00:00:00 2001
From: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com>
Date: Thu, 5 Dec 2024 10:48:56 +0100
Subject: [PATCH 1/3] docs: update release guide with PyPA action

---
 README.md | 26 ++++++++++++--------------
 1 file changed, 12 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index f856eae..9d3d937 100644
--- a/README.md
+++ b/README.md
@@ -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.
+5. On the `main` branch, create and push the release tag. For example: `git tag 1.2.3 -m 1.2.3 && git push --tags`.
+6. Done!

From 12580dc929413d34813e164151e300023d4e5941 Mon Sep 17 00:00:00 2001
From: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com>
Date: Thu, 5 Dec 2024 11:02:24 +0100
Subject: [PATCH 2/3] Update README.md

Co-authored-by: Techassi <git@techassi.dev>
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9d3d937..4cf9df3 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,6 @@ 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.
+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 --tags`.
 6. Done!

From 04da7ed6672fb14edbbac60ff76eae2cda02e807 Mon Sep 17 00:00:00 2001
From: Razvan-Daniel Mihai <84674+razvan@users.noreply.github.com>
Date: Thu, 5 Dec 2024 11:04:52 +0100
Subject: [PATCH 3/3] review feedback

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4cf9df3..b97a570 100644
--- a/README.md
+++ b/README.md
@@ -75,5 +75,5 @@ To release a new version follow the steps below:
 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 --tags`.
+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!