release: add release script #903

Elbehery · 2025-02-10T23:46:08Z

This PR adds release.sh script to automate the process of releasing bbolt repo.

resolves #896

Below is output of release.sh run

melbeher@melbeher-mac bbolt % ./scripts/release.sh               version_20250212
enter release string according to semantic versioning (e.g. v1.2.3).
v1.4.0-beta.15
fatal: a branch named 'version_20250212' already exists
Updating version from '1.4.0-alpha.0' to '1.4.0-beta.15' in 'version.go'
committing 'version.go'
[version_20250212 234b458] Update version to 1.4.0-beta.15
 1 file changed, 1 insertion(+), 1 deletion(-)
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 12 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (4/4), 379 bytes | 379.00 KiB/s, done.
Total 4 (delta 2), reused 0 (delta 0), pack-reused 0 (from 0)
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
To github.com:Elbehery/bbolt.git
 + 9ad97a4...234b458 version_20250212 -> version_20250212 (forced update)
branch 'version_20250212' set up to track 'origin/version_20250212'.
'version.go' has been committed to remote repo.
Creating new tag for 'v1.4.0-beta.15'
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0 (from 0)
To github.com:Elbehery/bbolt.git
 * [new tag]         v1.4.0-beta.15 -> v1.4.0-beta.15
Tag 'v1.4.0-beta.15' has been created and pushed to remote repo.
SUCCESS

scripts/release.sh

ivanvc · 2025-02-10T23:54:07Z

@Elbehery, we don't have a shellcheck CI check here (yet). Can you run shellcheck on your script? I believe there are a couple of instances where it will give warnings :)

Elbehery · 2025-02-11T00:20:58Z

@Elbehery, we don't have a shellcheck CI check here (yet). Can you run shellcheck on your script? I believe there are a couple of instances where it will give warnings :)

done 👍🏽 .. so it was mainly adding "" around vars 👍🏽

ivanvc

Thanks for the pull request, @Elbehery. I left some comments ✌️

scripts/release.sh

ivanvc · 2025-02-12T03:41:23Z

scripts/release.sh

+  echo "committing version.go"
+  git commit -s -m "Update version to ${VERSION}"
+
+  git push -u origin "${BRANCH}"


If we're allowing to override REPOSITORY with an environment variable, we could also receive a REMOTE, and replace the origin instances with "${REMOTE}".

makes perfect sense

done 👍🏽

iiuc, you want to have user-input for the remote name, correct ?

I just think, the PR has to be created from origin to upstream anyways

please correct me if I'm wrong

I meant:

REMOTE="${REMOTE:-origin}"

Then later:

git push -u "${REMOTE}" "${BRANCH}"

origin is the name of the default remote. That's why I would call it "REMOTE" rather than "ORIGIN".

By the way, you missed changing it in line 59 (https://github.com/etcd-io/bbolt/pull/903/files#diff-1bba00e5aca52286a667c09eff92ba2ca8e3ca77e0d31b0599cc829ab0173389R59)

thx for quick review 👍🏽

on it

I meant:

REMOTE="${REMOTE:-origin}"

Then later:

git push -u "${REMOTE}" "${BRANCH}"

so I create a branch like this

date_string=$(date +%Y%m%d) local_branch_name="version_${date_string}"

I use this branch to push the changes

git push -u -f "${REMOTE}" "${local_branch_name}"

updated 👍🏽

ran it again now after changes

./scripts/release.sh version_20250213 enter release string according to semantic versioning (e.g. v1.2.3). v1.4.0-beta.20 fatal: a branch named 'version_20250213' already exists Updating version from '1.4.0-alpha.0' to '1.4.0-beta.20' in 'version.go' committing 'version.go' [version_20250213 c3d9930] Update version to 1.4.0-beta.20 1 file changed, 1 insertion(+), 1 deletion(-) Enumerating objects: 7, done. Counting objects: 100% (7/7), done. Delta compression using up to 12 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (4/4), 376 bytes | 376.00 KiB/s, done. Total 4 (delta 2), reused 0 (delta 0), pack-reused 0 (from 0) remote: Resolving deltas: 100% (2/2), completed with 2 local objects. To github.com:Elbehery/bbolt.git + 2e41368...c3d9930 version_20250213 -> version_20250213 (forced update) branch 'version_20250213' set up to track 'origin/version_20250213'. 'version.go' has been committed to remote repo. Creating new tag for 'v1.4.0-beta.20' Total 0 (delta 0), reused 0 (delta 0), pack-reused 0 (from 0) To github.com:Elbehery/bbolt.git * [new tag] v1.4.0-beta.20 -> v1.4.0-beta.20 Tag 'v1.4.0-beta.20' has been created and pushed to remote repo. SUCCESS

scripts/release.sh

k8s-ci-robot · 2025-02-12T21:17:51Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Elbehery
Once this PR has been reviewed and has the lgtm label, please ask for approval from ahrtr. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Elbehery · 2025-02-12T21:21:40Z

the last run after updates

melbeher@melbeher-mac bbolt % ./scripts/release.sh               version_20250212
enter release string according to semantic versioning (e.g. v1.2.3).
v1.4.0-beta.15
fatal: a branch named 'version_20250212' already exists
Updating version from '1.4.0-alpha.0' to '1.4.0-beta.15' in 'version.go'
committing 'version.go'
[version_20250212 234b458] Update version to 1.4.0-beta.15
 1 file changed, 1 insertion(+), 1 deletion(-)
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 12 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (4/4), 379 bytes | 379.00 KiB/s, done.
Total 4 (delta 2), reused 0 (delta 0), pack-reused 0 (from 0)
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
To github.com:Elbehery/bbolt.git
 + 9ad97a4...234b458 version_20250212 -> version_20250212 (forced update)
branch 'version_20250212' set up to track 'origin/version_20250212'.
'version.go' has been committed to remote repo.
Creating new tag for 'v1.4.0-beta.15'
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0 (from 0)
To github.com:Elbehery/bbolt.git
 * [new tag]         v1.4.0-beta.15 -> v1.4.0-beta.15
Tag 'v1.4.0-beta.15' has been created and pushed to remote repo.
SUCCESS

Signed-off-by: Mustafa Elbehery <melbeher@redhat.com>

ivanvc

Thanks for the changes, @Elbehery. Sorry if there has been a lot of back and forth. I should have tested your script locally (apologies). Thanks again :)

ivanvc · 2025-02-14T06:16:14Z

scripts/release.sh

+echo "committing 'version.go'"
+git add ./version/version.go
+git commit -s -m "Update version to ${VERSION}"
+git push -u -f "${REMOTE}" "${local_branch_name}"


I suggest removing the force. If we're pushing to the etcd-io remote, it should not be a good idea to force it (it may even be good to fail if it fails to push).

so iiuc, this script creates a branch in origin, to be used to create a PR against upstream

I don't think the script should push directly to etcd-io repos, please correct me if I'm wrong

ivanvc · 2025-02-14T06:17:04Z

scripts/release.sh

+   git tag -f "${INPUT}"
+   git push -f "${REMOTE}" "${INPUT}"


Here, too. I suggest removing the force.

ivanvc · 2025-02-14T06:17:26Z

scripts/release.sh

+# creating a branch to bump 'version.go'.
+date_string=$(date +%Y%m%d)
+local_branch_name="version_${date_string}"
+local_branch_err=$(git checkout -b "${local_branch_name}" | grep -E "error|fatal" || true )
+if [[ -n "${local_branch_err}" ]]; then
+  echo "${local_branch_err}"
+fi


I tested your script locally, and it works. However, I think creating a branch and creating the tag against the commit from that branch is conceptually wrong. I believe the right way would be to push straight to the release-${VERSION_MINOR} branch (which is where the script should have been executed from) so the tag and the commit belong to that branch.

I see, now I got what u mean

so we execute the script from the local release-${VERSION_MINOR} branch

iiuc, this should pushed to a fork, which then used to create a PR against upstream, or ?

ivanvc · 2025-02-14T06:19:18Z

scripts/release.sh

+   git checkout -q "tags/${INPUT}"
+elif [ "${remote_tag_exists}" -eq 0 ]; then
+   echo "Creating new tag for '${INPUT}'"
+   git tag -f "${INPUT}"


Do we want to GPG sign the tag in this repository, too? I don't think we've been doing it, but it may be easier with the script in place. What do you think, @ahrtr?

Do we want to GPG sign the tag in this repository, too?

I think so. It's exactly what I have been doing (manually).

@ahrtr should the script

pushes a branch with the changes and new tag to a fork (origin)

pushes the changes directly to upstream (etcd-io) release branch (e.g. release-1.4)

I think the latter, else the tag would be in a fork, and we'll need to manually tag the upstream later.

A gentle reminder, @ahrtr. I think we're just waiting for confirmation on this.

Yes, we should push the changes to upstream etcd-io/bbolt directly. But please ensure you verify this in your forked repo firstly. I. believe @ivanvc did similar work lots of times.

k8s-ci-robot added the size/M label Feb 10, 2025

Elbehery force-pushed the 20250210-add-release-script branch from 0b369bb to 7649a72 Compare February 10, 2025 23:46

Elbehery commented Feb 10, 2025

View reviewed changes

scripts/release.sh Outdated Show resolved Hide resolved

Elbehery commented Feb 10, 2025

View reviewed changes

scripts/release.sh Outdated Show resolved Hide resolved

Elbehery force-pushed the 20250210-add-release-script branch from 7649a72 to d35e27d Compare February 11, 2025 00:20

Elbehery force-pushed the 20250210-add-release-script branch 2 times, most recently from 50ecec3 to ff51289 Compare February 11, 2025 15:37

Elbehery assigned ahrtr Feb 11, 2025

ivanvc reviewed Feb 12, 2025

View reviewed changes

Elbehery force-pushed the 20250210-add-release-script branch from ff51289 to 17b4956 Compare February 12, 2025 21:17

Elbehery force-pushed the 20250210-add-release-script branch 2 times, most recently from f10036b to 5a05933 Compare February 12, 2025 21:18

Elbehery force-pushed the 20250210-add-release-script branch 2 times, most recently from e24ec75 to 9afab2b Compare February 12, 2025 23:59

release: add release script

fe76a05

Signed-off-by: Mustafa Elbehery <melbeher@redhat.com>

Elbehery force-pushed the 20250210-add-release-script branch from 9afab2b to fe76a05 Compare February 13, 2025 10:49

ivanvc reviewed Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

release: add release script #903

release: add release script #903

Elbehery commented Feb 10, 2025 •

edited

Loading

ivanvc commented Feb 10, 2025

Elbehery commented Feb 11, 2025

ivanvc left a comment

ivanvc Feb 12, 2025

Elbehery Feb 12, 2025

Elbehery Feb 12, 2025

Elbehery Feb 12, 2025

ivanvc Feb 12, 2025

ivanvc Feb 12, 2025

Elbehery Feb 12, 2025

Elbehery Feb 12, 2025

Elbehery Feb 12, 2025

Elbehery Feb 13, 2025

k8s-ci-robot commented Feb 12, 2025

Elbehery commented Feb 12, 2025

ivanvc left a comment

ivanvc Feb 14, 2025

Elbehery Feb 14, 2025

ivanvc Feb 14, 2025

ivanvc Feb 14, 2025 •

edited

Loading

Elbehery Feb 14, 2025

ivanvc Feb 14, 2025

ahrtr Feb 14, 2025

Elbehery Feb 14, 2025

ivanvc Feb 14, 2025 •

edited

Loading

ivanvc Feb 20, 2025

ahrtr Feb 20, 2025

release: add release script #903

Are you sure you want to change the base?

release: add release script #903

Conversation

Elbehery commented Feb 10, 2025 • edited Loading

ivanvc commented Feb 10, 2025

Elbehery commented Feb 11, 2025

ivanvc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 12, 2025

Elbehery commented Feb 12, 2025

ivanvc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivanvc Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivanvc Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Elbehery commented Feb 10, 2025 •

edited

Loading

ivanvc Feb 14, 2025 •

edited

Loading

ivanvc Feb 14, 2025 •

edited

Loading