Skip to content

A platform for community discussion. Free, open, simple.

DEV: Bump version automatically when cutting release branches (#38504)

Loïc Guitautf77f59a5c18c
diff --git a/lib/release_utils/version.rb b/lib/release_utils/version.rb
index 2c279e6407e..c5aa1ef17ce 100644
--- a/lib/release_utils/version.rb
+++ b/lib/release_utils/version.rb
@@ -78,10 +78,17 @@ module ReleaseUtils
end
def next_revision
- raise "next_revision can only be called on development versions" unless development?
self.class.new("#{major}.#{minor}.#{patch}-#{pre}.#{revision.to_i + 1}")
end
+ def release_version
+ self.class.new("#{major}.#{minor}.#{patch}")
+ end
+
+ def next_patch
+ self.class.new("#{major}.#{minor}.#{patch + 1}")
+ end
+
def to_s
"#{major}.#{minor}.#{patch}#{"-#{pre}" if pre}#{".#{revision}" if revision}"
end
diff --git a/lib/tasks/release.rake b/lib/tasks/release.rake
index f4d457620f2..02b3a4710a0 100644
--- a/lib/tasks/release.rake
+++ b/lib/tasks/release.rake
@@ -44,6 +44,12 @@ module ReleaseUtils
File.write("lib/version.rb", read_version_rb.sub(/STRING = ".*"/, "STRING = \"#{version}\""))
end
+ def self.commit_version_bump(version, message)
+ write_version(version)
+ git "add", "lib/version.rb"
+ git "commit", "-m", message
+ end
+
def self.update_versions_json(new_version)
today_date = DateTime.now.utc.strftime("%Y-%m-%d")
@@ -202,20 +208,25 @@ namespace :release do
raise "New version is smaller than old version" if new_version < previous_version
- ReleaseUtils.git("branch", previous_version.branch_name, "#{check_ref}^1")
- puts "Created new branch #{previous_version.branch_name}"
+ branch_name = previous_version.branch_name
+ release_version = previous_version.release_version
- File.write(
- ENV["GITHUB_OUTPUT"] || "/dev/null",
- "new_branch_name=#{previous_version.branch_name}\n",
- mode: "a",
- )
+ ReleaseUtils.with_clean_worktree("main") do
+ ReleaseUtils.git("checkout", "#{check_ref}^1")
+ ReleaseUtils.git("checkout", "-b", branch_name)
- if ReleaseUtils.dry_run?
- puts "[DRY RUN] Skipping pushing branch #{previous_version.branch_name} to origin"
- else
- ReleaseUtils.git("push", "--set-upstream", "origin", previous_version.branch_name)
- puts "Pushed branch #{previous_version.branch_name} to origin"
+ ReleaseUtils.commit_version_bump(release_version, "DEV: Bump version to v#{release_version}")
+
+ puts "Created new branch #{branch_name} with version #{release_version}"
+
+ File.write(ENV["GITHUB_OUTPUT"] || "/dev/null", "new_branch_name=#{branch_name}\n", mode: "a")
+
+ if ReleaseUtils.dry_run?
+ puts "[DRY RUN] Skipping pushing branch #{branch_name} to origin"
+ else
+ ReleaseUtils.git("push", "--set-upstream", "origin", branch_name)
+ puts "Pushed branch #{branch_name} to origin"
+ end
end
puts "Done!"
@@ -355,9 +366,7 @@ namespace :release do
DESC
task "stage_security_fixes", [:base] do |t, args|
base = args[:base]
- if !base.start_with?("release/") && !%w[stable main].include?(base)
- raise "Unknown base: #{base.inspect}"
- end
+ raise "Unknown base: #{base.inspect}" unless base.start_with?("release/") || base == "main"
fix_refs = ENV["SECURITY_FIX_REFS"]&.split(",")&.map(&:strip)
private_mirror_pr_numbers = []
@@ -425,9 +434,13 @@ namespace :release do
"Bump the `latest` branch revision to #{ReleaseUtils::Version.current.next_revision}? This should only be done for security-fix merges which are not part of a regular monthly release.",
)
new_version = ReleaseUtils::Version.current.next_revision
- ReleaseUtils.write_version(new_version)
- ReleaseUtils.git "add", "lib/version.rb"
- ReleaseUtils.git "commit", "-m", "DEV: Bump development branch to v#{new_version}"
+ ReleaseUtils.commit_version_bump(
+ new_version,
+ "DEV: Bump development branch to v#{new_version}",
+ )
+ elsif base.start_with?("release/")
+ new_version = ReleaseUtils::Version.current.next_patch
+ ReleaseUtils.commit_version_bump(new_version, "DEV: Bump release branch to v#{new_version}")
end
puts "Finished merging commits into a locally-staged #{branch} branch. Git log is:"
diff --git a/spec/lib/release_utils/version_spec.rb b/spec/lib/release_utils/version_spec.rb
index 5cd8be75b09..298ac4c5aba 100644
--- a/spec/lib/release_utils/version_spec.rb
+++ b/spec/lib/release_utils/version_spec.rb
@@ -372,4 +372,42 @@ RSpec.describe ReleaseUtils::Version do
it { is_expected.to eq("2025.10.0-latest.3") }
end
end
+
+ describe "#release_version" do
+ subject(:release_version) { described_class.new(version_string).release_version }
+
+ context "with a development version" do
+ let(:version_string) { "2025.10.0-latest" }
+
+ it { is_expected.to eq("2025.10.0") }
+ end
+
+ context "with a development version with revision" do
+ let(:version_string) { "2025.10.0-latest.2" }
+
+ it { is_expected.to eq("2025.10.0") }
+ end
+
+ context "with a release version" do
+ let(:version_string) { "2025.10.1" }
+
+ it { is_expected.to eq("2025.10.1") }
+ end
+ end
+
+ describe "#next_patch" do
+ subject(:next_version) { described_class.new(version_string).next_patch }
+
+ context "with a release version" do
+ let(:version_string) { "2025.10.0" }
+
+ it { is_expected.to eq("2025.10.1") }
+ end
+
+ context "with an existing patch" do
+ let(:version_string) { "2025.10.3" }
+
+ it { is_expected.to eq("2025.10.4") }
+ end
+ end
end
diff --git a/spec/tasks/release_spec.rb b/spec/tasks/release_spec.rb
index 68c7cb65475..ffcc381abeb 100644
--- a/spec/tasks/release_spec.rb
+++ b/spec/tasks/release_spec.rb
@@ -1,6 +1,6 @@
# frozen_string_literal: true
-RSpec.describe "tasks/version_bump" do
+RSpec.describe "tasks/release" do
let(:tmpdir) { Dir.mktmpdir }
let(:origin_path) { "#{tmpdir}/origin-repo" }
let(:local_path) { "#{tmpdir}/local-repo" }
@@ -231,11 +231,17 @@ RSpec.describe "tasks/version_bump" do
context "when development cycle changes" do
let!(:previous_hash) { Dir.chdir(local_path) { commit_version(previous_version) } }
let!(:latest_hash) { Dir.chdir(local_path) { commit_version(current_version) } }
-
- def branch_tip(branch)
+ let(:release_branch) { "release/#{previous_version.split(".").first(2).join(".")}" }
+ let(:parent_of_tip) do
+ Dir.chdir(origin_path) do
+ git "checkout", release_branch
+ git("rev-parse", "HEAD^1").strip
+ end
+ end
+ let(:version_on_branch) do
Dir.chdir(origin_path) do
- git "checkout", branch
- git("rev-parse", "HEAD").strip
+ git "checkout", release_branch
+ File.read("lib/version.rb")[/STRING = "(.*)"/, 1]
end
end
@@ -243,10 +249,14 @@ RSpec.describe "tasks/version_bump" do
let(:previous_version) { "2025.1.0-latest" }
let(:current_version) { "2025.2.0-latest" }
- it "creates a release branch at the previous commit" do
+ it "creates a release branch based on the previous commit" do
Dir.chdir(local_path) { run_task }
+ expect(parent_of_tip).to eq(previous_hash)
+ end
- expect(branch_tip("release/2025.1")).to eq(previous_hash)
+ it "strips the -latest suffix" do
+ Dir.chdir(local_path) { run_task }
+ expect(version_on_branch).to eq("2025.1.0")
end
end
@@ -254,10 +264,9 @@ RSpec.describe "tasks/version_bump" do
let(:previous_version) { "2025.11.0-latest.2" }
let(:current_version) { "2025.12.0-latest" }
- it "creates a release branch at the previous commit" do
+ it "creates a release branch based on the previous commit" do
Dir.chdir(local_path) { run_task }
-
- expect(branch_tip("release/2025.11")).to eq(previous_hash)
+ expect(parent_of_tip).to eq(previous_hash)
end
end
end
@@ -453,20 +462,22 @@ RSpec.describe "tasks/version_bump" do
describe "release:stage_security_fixes" do
subject(:run_task) do
Dir.chdir(local_path) do
- capture_stdout { invoke_rake_task("release:stage_security_fixes", "main") }
+ capture_stdout { invoke_rake_task("release:stage_security_fixes", base_branch) }
end
end
+ let(:base_branch) { "main" }
let(:origin_main_commits) do
- Dir.chdir(origin_path) { git("log", "--pretty=%s", "main").lines.map(&:strip) }
+ Dir.chdir(origin_path) { git("log", "--pretty=%s", base_branch).lines.map(&:strip) }
end
+ let(:security_fixes) { "origin/security-fix-one,origin/security-fix-two" }
def origin_file(path)
- Dir.chdir(origin_path) { git("show", "main:#{path}") }
+ Dir.chdir(origin_path) { git("show", "#{base_branch}:#{path}") }
end
before do
- ENV["SECURITY_FIX_REFS"] = "origin/security-fix-one,origin/security-fix-two"
+ ENV["SECURITY_FIX_REFS"] = security_fixes
Dir.chdir(origin_path) do
git "checkout", "-b", "security-fix-one"
File.write("firstfile.txt", "contents")
@@ -532,5 +543,44 @@ RSpec.describe "tasks/version_bump" do
expect(origin_file("lib/version.rb")).to include('STRING = "2025.12.0-latest"')
end
end
+
+ context "when targeting a release branch" do
+ let(:base_branch) { "release/2025.6" }
+ let(:security_fixes) { "origin/security-fix-for-release-branch" }
+
+ before do
+ Dir.chdir(origin_path) do
+ git "checkout", "-b", base_branch
+ File.write("lib/version.rb", fake_version_rb("2025.6.0"))
+ git "add", "lib/version.rb"
+ git "-c", "commit.gpgsign=false", "commit", "-m", "Initial release branch commit"
+ git "config", "receive.denyCurrentBranch", "ignore"
+ git "checkout", "main"
+
+ git "checkout", "-b", "security-fix-for-release-branch"
+ File.write("releasefile.txt", "contents")
+ git "add", "releasefile.txt"
+ git "-c", "commit.gpgsign=false", "commit", "-m", "security fix for release branch"
+ end
+
+ Dir.chdir(local_path) { git "fetch", "origin" }
+ end
+
+ it "bumps the patch version" do
+ run_task
+ expect(origin_file("lib/version.rb")).to include('STRING = "2025.6.1"')
+ end
+
+ it "cherry-picks security fixes and adds version bump commit" do
+ run_task
+ expect(origin_main_commits.first(3)).to eq(
+ [
+ "DEV: Bump release branch to v2025.6.1",
+ "security fix for release branch",
+ "Initial release branch commit",
+ ],
+ )
+ end
+ end
end
end