git-maintain 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 868f7d13ca258e469a2a32f892646f22486c006b2dd6cdd927a8df4ee349aaaf
-  data.tar.gz: ee9fabe23d3918015bd195d67ca36d528dba9d993574749134e338143d06429f
+  metadata.gz: 3f55eb06d04154df930e2e69d85b4d0d3b882361681f2d70a2acc503dc9abfad
+  data.tar.gz: 6d4597f517459cf6304ca419ef7b4897b894c032200f311a1efd549524fc13ba
 SHA512:
-  metadata.gz: 306f260c676c76fc85d2bf87b797e3e8831cdcdd5fb0d847f3d7515e6b68ca35d271dd2348d6b1f850300c22a806be344b8eeeac382e9ed02ab19d3dabe18aab
-  data.tar.gz: c7a5aae40d1ab800006f6bc8aa9674eaced5a9acc5ec92a71e338d85a75e9e19768dce0be894b3a846c7976a5b2df189292c2973d31c86aadf0e9a9fdbd66a4e
+  metadata.gz: 9363ed5154f62cef4ac12ee4a1599c108f48bd192dcaea8154cbf4b0db3f80eda06baf8972f39986d8870b6cf5c812ad6877d0fd75c24eb594e4f9e96dc53731
+  data.tar.gz: 97d60ac6e78bec2d3c8c6233e99412f4941c1e9fed9f69f1ce9acc923e9f3060279c9a82d7dd6f50a66b6c50c6799c0d686e86aeaec984b8fe704e018497f3d9

data/CHANGELOG

@@ -1,3 +1,32 @@
+------------------
+0.12.0  (2025-09-11)
+------------------
+
+* Cleanup code for Addons releases
+* Replace all egrep calls with grep -E
+* Replace $? handling with Exceptions
+* Various minor fixes
+* Drop obsolete Travis CI code
+
+------------------
+0.11.0  (2025-04-15)
+------------------
+
+* Add github workflow for CI and publishing released rubygems
+
+------------------
+0.10.0  (2025-04-15)
+------------------
+
+* Fix and extend CI
+* Add addons info in general help and repo summary
+* Add ENV var to point to custom addons
+* Addons updates
+* Set PS1_WARNING to help dealing with subshell status
+* Azure fixes
+* Remove list_stable, monitor_stable, push_stable commands. Replace with --stable option of the regular ones
+* Add pull command
+
 ------------------
 0.9.0  (2022-10-18)
 ------------------

data/README.md

@@ -13,12 +13,9 @@ The idea is to script most of the maintenance tasks so the maintainer can focus
 - **delete**: Delete all local branches using the suffix
 - **steal**: Steal commit from upstream that fixes commit in the branch or were tagged as stable
 - **list**: List commit present in the branch but not in the stable branch
-- **list_stable**: List commit present in the stable branch but not in the latest associated relase
 - **merge**: Merge branch with suffix specified in -m <suff> into the main branch
 - **push**: Push branches to github for validation
 - **monitor**: Check the CI state of all branches
-- **push_stable**: Push to stable repo
-- **monitor_stable**: Check the CI state of all stable branches
 - **release**: Create new release on all concerned branches
 - **reset**: Reset branch against upstream
 - **submit_release**: Push the to stable and create the release packages
@@ -167,7 +164,7 @@ Some time later, check their status
 
 If everything looks good, push to the stable repo
 
-```git maintain push_stable --version '1[789]'```
+```git maintain push --stable --version '1[789]'```
 
 If patches have been sent to the ML but are not yet accepted, I usually try them out on a "pending" branch.
 
@@ -225,6 +222,11 @@ To run:
 Once some work has been done, it is time for a new release.
 
 First, unless you're working for the rdma-core repo, you'll need to add your own 'add-on' class to do automatize tyour release process. Please look at 'addons/RDMACore.rb' for an example.
+Addons should be '.rb' file placed either in the same directory as pre-installed addons, or in a directory pointed to by the environment variable GIT_MAINTAIN_ADDON_DIR.
+
+To list available addons, run:
+
+```git maintain -h```
 
 Then all you need to do is create your release(s)
 
@@ -232,16 +234,16 @@ Then all you need to do is create your release(s)
 
 This will run your addon code. What you usually want to do in there is create a tag and eventually bump version numbers, add releases notes, etc.
 
-I strongly advise here to then use the 'push_stable' command. It will update the branches, but NOT push the tag.
+I strongly advise here to then use the 'push --stable' command. It will update the branches, but NOT push the tag.
 This means that if something has been broken by the release commit (if any), there is still time to fix it.
 
 The tag will not have been propagated anywhere else and can be deleted manually.
 
-```git maintain push_stable --version '1[789]'```
+```git maintain push --stable --version '1[789]'```
 
 You can then monitor the status on CI
 
-```git maintain monitor_stable --version '1[789]'```
+```git maintain monitor --stable --version '1[789]'```
 
 
 Once everything is green, it is time to submit your release

data/bin/git-maintain

@@ -23,6 +23,15 @@ actionParser.separator "Possible actions:"
 ACTION_HELPS.each(){|k, x|
     actionParser.separator "\t * " + k.to_s() + ": " + x
 }
+custom_classes = GitMaintain::getCustomClasses()
+if custom_classes.length > 0 then
+actionParser.separator "Custom repo addons available:"
+custom_classes.each(){|k, x|
+    actionParser.separator "\t * " + k.to_s()
+}
+
+end
+
 rest = actionParser.order!(ARGV);
 if rest.length <= 0 then
     STDERR.puts("Error: No action provided")

data/git-maintain-completion.sh

@@ -1,13 +1,13 @@
 export _GIT_MAINTAIN_CMD_AWK=$(([ -f /bin/awk ] && echo "/bin/awk") || echo "/usr/bin/awk")
 export _GIT_MAINTAIN_CMD_SORT=$(([ -f /bin/sort ] && echo "/bin/sort") || echo "/usr/bin/sort")
-export _GIT_MAINTAIN_CMD_EGREP=$(([ -f /bin/egrep ] && echo "/bin/egrep") || echo "/usr/bin/egrep")
+export _GIT_MAINTAIN_CMD_GREP=$(([ -f /bin/grep ] && echo "/bin/grep") || echo "/usr/bin/grep")
 export _GIT_MAINTAIN_CMD_SED=$(([ -f /bin/sed ] && echo "/bin/sed") || echo "/usr/bin/sed")
 
 _git_maintain_genoptlist(){
 	local COMMAND=$*
 	${COMMAND}  --help 2>&1 | \
 		${_GIT_MAINTAIN_CMD_AWK} 'BEGIN { found = 0 } { if(found == 1) print $$0; if($$1 == "Options:") {found = 1}}' | \
-		${_GIT_MAINTAIN_CMD_EGREP} -e "^[[:space:]]*--" -e "^[[:space:]]*-[a-zA-Z0-9]" | \
+		${_GIT_MAINTAIN_CMD_GREP} -E -e "^[[:space:]]*--" -e "^[[:space:]]*-[a-zA-Z0-9]" | \
 		${_GIT_MAINTAIN_CMD_SED} -e 's/^[[:space:]]*//' -e 's/^-[^-], //' | \
 		${_GIT_MAINTAIN_CMD_AWK} '{ print $1}' | \
 		${_GIT_MAINTAIN_CMD_SED} -e 's/^\(.*\)\[no-\]\(.*$\)/\1\2\n\1no-\2/' | \

data/lib/addons/RDMACore.rb

@@ -2,6 +2,10 @@ module GitMaintain
     class RDMACoreBranch < Branch
         REPO_NAME = "rdma-core"
         AZURE_MIN_VERSION = 18
+        ACTION_LIST = Branch::ACTION_LIST + [ :validate ]
+        ACTION_HELP = {
+            :validate => "Validate that branch still builds"
+        }.merge(Branch::ACTION_HELP)
 
         def self.set_opts(action, optsParser, opts)
             opts[:rel_type] = nil
@@ -28,7 +32,7 @@ module GitMaintain
             end
         end
         def release(opts)
-            prev_ver=@repo.runGit("show HEAD:CMakeLists.txt  | egrep \"[sS][eE][tT]\\\\(PACKAGE_VERSION\"").
+            prev_ver=@repo.runGit("show HEAD:CMakeLists.txt  | grep -E \"[sS][eE][tT]\\\\(PACKAGE_VERSION\"").
                          chomp().gsub(/[sS][eE][tT]\(PACKAGE_VERSION\s*"([0-9.]*)".*$/, '\1')
             ver_nums = prev_ver.split(".")
             new_ver =  (ver_nums[0 .. -2] + [ver_nums[-1].to_i() + 1 ]).join(".")
@@ -45,8 +49,9 @@ module GitMaintain
 
             git_prev_ver = "v" + prev_ver
             # Older tags might do have the terminal minor version (.0) for major releases
-            @repo.runGit("rev-parse --verify --quiet #{git_prev_ver}")
-            if $? != 0 then
+            begin
+                @repo.ref_exist?(git_prev_ver)
+            rescue NoRefError
                 # Try without the minor version number
                 git_prev_ver = "v" + ver_nums[0 .. -2].join(".")
             end
@@ -76,10 +81,7 @@ module GitMaintain
 
             if opts[:rel_type] == :major
                 # For major, tag the current version first
-                @repo.runGitInteractive("tag -a -s v#{rel_ver} #{edit_flag} -F #{tag_path}")
-                if $? != 0 then
-                    raise("Failed to tag branch #{local_branch}")
-                end
+                release_do_tag(opts, "v" + rel_ver, tag_path)
             end
 
             # Update version number in relevant files
@@ -103,23 +105,30 @@ mv debian/changelog.new debian/changelog")
             end
 
             # Add and commit
-            @repo.runGit("add  */*.spec CMakeLists.txt debian/changelog")
-            @repo.runGitInteractive("commit -m '#{commit_msg} #{new_ver}' --verbose #{edit_flag} --signoff")
-            if $? != 0 then
-                raise("Failed to commit on branch #{local_branch}")
-            end
+            release_do_add_commit(opts, [ "*/*.spec", "CMakeLists.txt", "debian/changelog" ],
+                                  new_ver, nil, "#{commit_msg} #{new_ver}")
 
             if opts[:rel_type] == :stable
-                @repo.runGitInteractive("tag -a -s v#{rel_ver} #{edit_flag} -F #{tag_path}")
-                if $? != 0 then
-                    raise("Failed to tag branch #{local_branch}")
-                end
+                release_do_tag(opts, rel_ver, tag_path)
             end
             `rm -f #{tag_path}`
+            return 0
+        end
+        def validate(opts)
+            begin
+                @repo.runSystem("rm -Rf build/ && mkdir build/ && cd build/ && cmake .. && make -j")
+            rescue RuntimeError
+                raise("Validation failure")
+            end
         end
     end
     class RDMACoreRepo < Repo
         AZURE_MIN_VERSION = 18
+        ACTION_LIST = Repo::ACTION_LIST + [ :create_stable ]
+        ACTION_HELP = {
+            :create_stable => "Create a stable branch from a release tag"
+        }.merge(Repo::ACTION_HELP)
+
         def submitReleases(opts, new_tags)
             new_tags.each(){|tag|
                 next if tag !~ /v([0-9]*)\.[0-9]*/
@@ -128,6 +137,52 @@ mv debian/changelog.new debian/changelog")
                 createRelease(opts, tag, major < AZURE_MIN_VERSION)
             }
         end
+
+        def self.set_opts(action, optsParser, opts)
+            case action
+            when :create_stable then
+                optsParser.on("-V", "--version [NUM]", Integer,
+                              "Specify which version to use to create the stable branch.") {
+                |val| opts[:version] = val}
+                optsParser.on("-S", "--skip",
+                              "Skip docker image generation") {
+                |val| opts[:skip_docker] = true}
+            end
+        end
+        def self.check_opts(opts)
+            case opts[:action]
+                when :create_stable
+                if opts[:version].to_s() == "" then
+                    raise "Action #{opts[:action]} requires a branch number to be specified"
+                end
+                 if opts[:br_suff] != "master" then
+                    raise "Action #{opts[:action]} can only be done on 'master' suffixed branches"
+                end
+           end
+        end
+        def create_stable(opts)
+            ver = opts[:version].to_s()
+            suff = opts[:br_suff]
+            if getBranchList(suff).index(ver) != nil then
+                raise("Local branch already exists for version #{ver}")
+            end
+            br = versionToLocalBranch(ver, suff)
+            full_ver = ver.gsub(/([0-9]+)/, @stable_base_format)
+            runGit("checkout -B #{br} #{full_ver}")
+            cmdList = `awk '/\`\`\`/{p=!p; next};p' Documentation/stable.md`.chomp().split("\n")
+            if opts[:skip_docker] == true then
+                cmdList = cmdList.map(){|x| x if x !~ /build-images/}.compact()
+            end
+            cmdList = cmdList.map(){|x| (x !~ /pkg azp/) ? x : (x + " || true") }.compact()
+            cmdList << "./buildlib/cbuild pkg azp"
+
+            toDo=cmdList.join("&&")
+            begin
+                runSystem(toDo)
+            rescue RuntimeError
+                raise("Fail to run stable creation code")
+            end
+        end
     end
 
     class RDMACoreCI < CI

data/lib/addons/git-maintain.rb

@@ -1,19 +1,47 @@
 module GitMaintain
     class GitMaintainBranch < Branch
         REPO_NAME = "git-maintain"
+        def self.set_opts(action, optsParser, opts)
+            opts[:rel_type] = nil
 
+            case action
+            when :release
+                 optsParser.on("--major [VERSION]", "Release a major version.") {|val|
+                     opts[:rel_type] = :major
+                     opts[:new_ver] = val
+                 }
+                 optsParser.on("--stable", "Release a stable version.") {
+                     opts[:rel_type] = :stable
+                 }
+           end
+        end
+        def self.check_opts(opts)
+            if opts[:action] == :release then
+                case opts[:rel_type]
+                when nil
+                    raise "No release type specified use --stable or --major"
+                when :major
+                    if opts[:manual_branch] == nil then
+                        GitMaintain::log(:INFO, "Major release selected. Auto-forcing branch to master")
+                        opts[:manual_branch] = "master"
+                    end
+                end
+            end
+        end
         def release(opts)
             prev_ver=@repo.runGit("show HEAD:CHANGELOG | grep -A 1 -- '---------'  | head -n 2 | tail -n 1 | awk '{ print $1}'").chomp()
             ver_nums = prev_ver.split(".")
 
-            if opts[:manual_branch] == nil then
+            if opts[:rel_type] == :stable then
                 new_ver =  (ver_nums[0 .. -2] + [ver_nums[-1].to_i() + 1 ]).join(".")
                 git_prev_ver = "v" + (ver_nums[-1] == "0" ? ver_nums[0 .. -2].join(".") : prev_ver)
-            else
+            elsif opts[:rel_type] == :major then
                 new_ver =  (ver_nums[0 .. -3] + [ver_nums[-2].to_i() + 1 ] + [ "0" ]).join(".")
+                new_ver = opts[:new_ver] if opts[:new_ver] != nil
                 git_prev_ver = "v" + prev_ver
             end
 
+
             changes=@repo.runGit("show HEAD:CHANGELOG |  awk ' BEGIN {count=0} {if ($1 == \"------------------\") count++; if (count == 0) print $0}'")
 
             puts "Preparing release #{prev_ver} => #{new_ver}"
@@ -41,17 +69,9 @@ $(cat CHANGELOG)
 EOF
 mv CHANGELOG.new CHANGELOG")
 
-            # Add and commit
-            @repo.runGit("add  CHANGELOG")
-            @repo.runGitInteractive("commit -F #{tag_path} --verbose --edit --signoff")
-            if $? != 0 then
-                raise("Failed to commit on branch #{local_branch}")
-            end
-            @repo.runGitInteractive("tag -a -s v#{new_ver} --edit -F #{tag_path}")
-            if $? != 0 then
-                raise("Failed to tag branch #{local_branch}")
-            end
+            release_do_add_commit_tag(opts, ["CHANGELOG"], "v" + new_ver, tag_path)
             `rm -f #{tag_path}`
+            return 0
         end
     end
     class GitMaintainRepo < Repo

data/lib/azure.rb

@@ -13,7 +13,7 @@ module GitMaintain
         def getState(sha1, resp)
             br = findBranch(sha1, resp)
             return "not found" if br == nil
-            return "running" if br["result"] == nil
+            return "started" if br["result"] == nil
             return br["result"].to_s()
         end
         def getLog(sha1, resp)
@@ -34,7 +34,7 @@ module GitMaintain
         def getTS(sha1, resp)
             br = findBranch(sha1, resp)
             raise("Travis build not found") if br == nil
-            return br["started_at"]
+            return br["startTime"]
         end
         def checkState(sha1, resp)
             st = getState(sha1, resp)