Merge pull request #354 from github/adjust-release-script-to-support-patch-version

Adjusting backup-utils Release Script To Support Patch Versions

Author: JoeFranks1993

script/release

@@ -31,7 +31,8 @@ GH_REPO = ENV['GH_REPO'] || 'backup-utils'
 GH_OWNER = ENV['GH_OWNER'] || 'github'
 GH_AUTHOR = ENV['GH_AUTHOR']
 DEB_PKG_NAME = 'github-backup-utils'
-GH_BASE_BRANCH = ENV['GH_BASE_BRANCH'] || 'master'
+GH_BASE_BRANCH = ENV['GH_BASE_BRANCH'] || 'master' # TODO: should we even allow a default or require all params get set explicitly?
+GH_STABLE_BRANCH = ""
 
 CHANGELOG_TMPL = '''<%= package_name %> (<%= package_version %>) UNRELEASED; urgency=medium
 
@@ -137,7 +138,8 @@ def beautify_changes(changes)
 end
 
 def changelog
-  changes = `git log --pretty=oneline origin/stable...origin/#{GH_BASE_BRANCH} --reverse --grep "Merge pull request" | sort -t\# -k2`.lines.map(&:strip)
+  puts "building changelog by comparing origin/#{GH_STABLE_BRANCH}...origin/#{GH_BASE_BRANCH}"
+  changes = `git log --pretty=oneline origin/#{GH_STABLE_BRANCH}...origin/#{GH_BASE_BRANCH} --reverse --grep "Merge pull request" | sort -t\# -k2`.lines.map(&:strip)
   raise 'Building the changelog failed' if $CHILD_STATUS != 0
 
   changes
@@ -228,12 +230,12 @@ def push_release_branch(version)
 end
 
 def update_stable_branch
-  `git checkout --quiet stable`
+  `git checkout --quiet #{GH_STABLE_BRANCH}`
   unless (out = `git merge --quiet --ff-only origin/#{GH_BASE_BRANCH}`)
-    warn "Merging #{GH_BASE_BRANCH} into stable failed:\n\n#{out}"
+    warn "Merging #{GH_BASE_BRANCH} into #{GH_STABLE_BRANCH} failed:\n\n#{out}"
   end
-  unless (out = `git push --quiet origin stable`)
-    warn "Failed pushing the stable branch:\n\n#{out}"
+  unless (out = `git push --quiet origin #{GH_STABLE_BRANCH}`)
+    warn "Failed pushing the #{GH_STABLE_BRANCH} branch:\n\n#{out}"
   end
 end
 
@@ -333,9 +335,38 @@ def clean_up(version)
   `git branch --quiet -D tmp-packaging >/dev/null 2>&1`
 end
 
+def is_base_branch_valid?(branch)
+  if branch == "master" || branch.match(/^\d+\.\d+-main$/)
+    return true
+  else
+    return false
+  end
+end
+
+def get_stable_branch_name(branch)
+  ## derive the proper stable branch. if the base branch is "master" the stable branch is just "stable"
+  ## if the base branch is a release branch, the stable branch will be "x.y-stable"
+  result = ""
+  if branch == "master"
+    result = "stable"
+  else
+    result = branch.gsub(/-main$/, "-stable")
+  end
+
+  result
+end
+
 #### All the action starts ####
 if $PROGRAM_NAME == __FILE__
   begin
+    ## validate base branch. this must either be "master" or a release branch which will match the pattern "x.y-main"
+    raise "The branch #{GH_BASE_BRANCH} is not valid for releasing backup-utils. branch name must be master or match x.y-main" if !is_base_branch_valid?(GH_BASE_BRANCH)
+
+    GH_STABLE_BRANCH = get_stable_branch_name(GH_BASE_BRANCH)
+
+    puts "base branch = " + GH_BASE_BRANCH
+    puts "stable branch = " + GH_STABLE_BRANCH
+
     args = ARGV.dup
     dry_run = false
     skip_version_bump_check = false
@@ -455,7 +486,7 @@ if $PROGRAM_NAME == __FILE__
     puts 'Cleaning up...'
     clean_up version
 
-    puts 'Updating stable branch...'
+    puts "Updating #{GH_STABLE_BRANCH} branch..."
     update_stable_branch
 
     puts 'Released!'