git-maintain 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ccbf8e5307eaae5365b48a6ce99f026f020fa18acd0f34542cf8f4d8ecfbb51
-  data.tar.gz: de7a34ab07001688472118280ed5db9bed9016148a50f5009af2e9da5f16722e
+  metadata.gz: 417458e3750d9bcd3c32ec5ee53927fbfea2cd699673f72d50ec31a9cc1bb432
+  data.tar.gz: f95702ebdc24c0978b29627cfde6742fcf9ffe817d26609e895c12001cdc194c
 SHA512:
-  metadata.gz: 8ed529842a7c85ca7e13e969fe561edc671ddc5ef20a559484523a7b0643e01236205b7b9681eff7d123024771ea6037ceaa79cba388032dc2971dbf2938aa58
-  data.tar.gz: 2bb5406a3a5d028a7dbde47a2ccdf6ae4b69e4b1ab379e428069af14088dce6a5289e0fe74eccf32e45f9927a94bde7143f86efb172d05c464092852f7edec12
+  metadata.gz: 7682468b42e62b9513ae9227bef2af4e1e01e9078a1c46648382efaa895f2152e5bbe18488e1c2e45b0fad524be09d77e953bfb48f6f49e2a34cd72e2590d0f4
+  data.tar.gz: 954f1f014760fa1c02b1ebead5f093115da8dada78bfea1d041d527a41d37727aad9ba06f0d94e4d926c2fb725da4dc2c61cd4b5cbafe2093c8510d2d54e820a

data/CHANGELOG

@@ -1,3 +1,17 @@
+------------------
+0.7.0  (2019-05-29)
+------------------
+
+* Add summary command
+* push and push_stable now push all the selected branch at once
+* Add maintain.autofetch setting in gitconfig to enable/disable autofetch
+* Support 'errored' status in travis
+* Fix 'steal' command for commits containing double quotes
+* Fixes for rdma-core release procedure
+* Support send-email for release annoucenement
+* Fix support for interactive editor (ie vim)
+* Support repo specific action options
+
 ------------------
 0.6.0  (2019-03-21)
 ------------------

data/README.md

@@ -30,10 +30,10 @@ The idea is to script most of the maintenance tasks so the maintainer can focus
 - Load git-maintain-completion.sh for shell completion
 
 ## Remote setup
-- the 'github' remote should be your own WIP github to test out branches before submitting to the official repo.
+- the 'github' remote should be your own WIP github to test out branches before submitting to the official repo.  
   Also know as the 'Validation' repo. It can be switched to another remote by setting maintain.valid-repo=xxx in your gitconfig
 - the 'origin' remote should be the official repo in read-only mode to avoid any accidental pushes
-- the 'stable' remote should be the official repo in RW mode
+- the 'stable' remote should be the official repo in RW mode.  
   Also know as the 'Stable' repo. It can be switched to another remote by setting maintain.stable-repo=xxx in your gitconfig
 
 ## Stealing commits
@@ -41,10 +41,10 @@ The idea is to script most of the maintenance tasks so the maintainer can focus
 The steal feature uses was shamelessly copied it from https://git.kernel.org/pub/scm/linux/kernel/git/sashal/stable-tools.git/tree/
 
 ## Making releases
-The release process being very specific to each project, the release command does nothing by default.
+The release process being very specific to each project, the release command does nothing by default.  
 However the behaviour can be overriden for specific repo (detected by repo name)
 
-Check the lib/addons/RDMACore.rb for an example.
+Check the lib/addons/RDMACore.rb for an example.  
 In this case, the release command bump the version in all the appropriate files (after computing the previous and next version numbers), commit and tags the commit.
 
 
@@ -119,9 +119,36 @@ v\1
 
 Note that this value can be overriden by the stable-base.XXX value if needed
 
+To verify your setup, you can run 'git maintain summary' which will show you your configured values and the matching local and upstrema branches that git-maintain sees
+```
+$ git maintain summary
+# INFO: Configuration summary:
+# INFO: Stable remote: stable
+# INFO: Validation remote: github
+# INFO: 
+# INFO: Branch config:
+# INFO: Local branch format: /dev\/stable-v([0-9]*)/
+# INFO: Remote stable branch format: stable-v\1
+# INFO: Remote stable base format: v\1
+# INFO: 
+# INFO: Local branches:
+# INFO: dev/stable-v15/master -> stable/stable-v15
+# INFO: dev/stable-v16/master -> stable/stable-v16
+# INFO: dev/stable-v17/master -> stable/stable-v17
+# INFO: dev/stable-v18/master -> stable/stable-v18
+# INFO: dev/stable-v19/master -> stable/stable-v19
+# INFO: dev/stable-v20/master -> stable/stable-v20
+# INFO: dev/stable-v21/master -> stable/stable-v21
+# INFO: dev/stable-v22/master -> stable/stable-v22
+# INFO: 
+# INFO: Upstream branches:
+# INFO: <MISSING> -> stable/stable-v23
+```
+
 Also, once you set these parameters, you can have git-maintain create all branches for you by running
-``
+```
 $ git maintain create
+# INFO: Creating missing dev/stable-v23/master from stable/stable-v23
 ```
 ## Day-to-day workflow
 
@@ -227,3 +254,23 @@ Review your email, send it and your day is over !
 
 Enjoy, and feel free to report bugs, missing features and/or send patches
 
+## Git config settings
+
+This is a summary of all the settings that can be set in the git config:
+
+- `maintain.autofetch`: Enable/Disable auto fetching.  
+   Can be overriden by the --[no-]fetch option on the CLI.  
+   If unset, autofetch is enabled
+- `maintain.branch-format`: Local branch name space that also extracts the version.  
+   Example: dev\/stable-v([0-9]*) will allow all branch names dev/stable-vXXX/foo to be used against stable branch with version XXX
+- `maintain.stable-branch-format`: Name of the stable branch generated with the version extracted by the `maintain.branch-format` regexp.  
+   Example: stable-v\1 will track dev/stable-vXXX/foo against <STABLE_REPO>/stable-vXXX
+- `maintain.stable-base-format`: Name of the tag from which the stable branch was forked from generated with the version extracted by the `maintain.branch-format` regexp.  
+   Example: v\1 will be mark vXXX has the fork tag for branch <STABLE_REPO>/stable-vXXX and local branch dev/stable-vXXX/foo  
+   This settings is only needed when using `git maintain steal` command  
+   This rule can be overriden by a specific entry in gitconfig:
+   `stable-base.dev---stable-vXXX vYY-ZZ`
+   As git does not allow `/` in gitconfig they are to be replaced by `---`
+ - `maintain.mail-format`: Specify how release annoucement emails are sent. Can be:
+   - `imap_send`: Store prepared email in an IMAP folder. See `main git-imap-send` for more infos. This is the default value.
+   - `send_email`: Generates a file which is compatible with git send-email

data/bin/git-maintain

@@ -20,7 +20,7 @@ actionParser.separator ""
 actionParser.separator "Options:"
 actionParser.on("-h", "--help", "Display usage.") { |val| puts actionParser.to_s; exit 0 }
 actionParser.separator "Possible actions:"
-GitMaintain::getActionAttr("ACTION_HELP").each(){|x|
+GitMaintain::getActionAttr("ACTION_HELP").sort.each(){|x|
     actionParser.separator "\t " + x
 }
 rest = actionParser.order!(ARGV);

data/lib/addons/RDMACore.rb

@@ -2,14 +2,49 @@ module GitMaintain
     class RDMACoreBranch < Branch
         REPO_NAME = "rdma-core"
 
+        def self.set_opts(action, optsParser, opts)
+            opts[:rel_type] = nil
+
+            case action
+            when :release
+                 optsParser.on("--major", "Release a major version.") {
+                     opts[:rel_type] = :major }
+                 optsParser.on("--stable", "Release a stable version.") {
+                     opts[:rel_type] = :stable }
+           end
+        end
+        def self.check_opts(opts)
+            if opts[:action] == :release then
+                if opts[:rel_type] == nil then
+                    raise "No release type specified use --stable or --major"
+                end
+            end
+        end
         def release(opts)
             prev_ver=@repo.runGit("show HEAD:CMakeLists.txt  | egrep \"[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(".")
-            git_prev_ver = "v" + (ver_nums[-1] == "0" ? ver_nums[0 .. -2].join(".") : prev_ver)
+            rel_ver = new_ver
+            commit_msg = "Bump to version"
 
-            puts "Preparing release #{prev_ver} => #{new_ver}"
+            if opts[:rel_type] == :major
+                new_ver = ([ ver_nums[0].to_i() + 1] + ver_nums[1 .. -1]).join(".")
+                rel_ver = prev_ver
+                prev_ver = ([ ver_nums[0].to_i() - 1] + ver_nums[1 .. -1]).join(".")
+                ver_nums = prev_ver.split(".")
+                commit_msg ="Update library version to be"
+            end
+
+            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
+                # Try without the minor version number
+                git_prev_ver = "v" + ver_nums[0 .. -2].join(".")
+            end
+
+            puts "Preparing #{opts[:rel_type].to_s} release #{prev_ver} => #{rel_ver}"
             rep = GitMaintain::checkLog(opts, @local_branch, git_prev_ver, "release")
             if rep != "y" then
                 puts "Skipping release"
@@ -20,18 +55,30 @@ module GitMaintain
             tag_path=`mktemp`.chomp()
             puts tag_path
             tag_file = File.open(tag_path, "w+")
-            tag_file.puts "rdma-core-#{new_ver}:"
+            tag_file.puts "rdma-core-#{rel_ver}:"
             tag_file.puts ""
             tag_file.puts "Updates from version #{prev_ver}"
-            tag_file.puts " * Backport fixes:"
-            tag_file.puts `git log HEAD ^#{git_prev_ver} --format='   * %s'`
+            if opts[:rel_type] == :stable then
+                tag_file.puts " * Backport fixes:"
+            end
+            tag_file.puts `git log HEAD ^#{git_prev_ver} --no-merges --format='   * %s'`
             tag_file.close()
 
+            if opts[:rel_type] == :major
+                # For major, tag the current version first
+                @repo.runGitInteractive("tag -a -s v#{rel_ver} --edit -F #{tag_path}")
+                if $? != 0 then
+                    raise("Failed to tag branch #{local_branch}")
+                end
+            end
+
             # Update version number in relevant files
-            @repo.run("sed -i -e 's/\\(Version:[[:space:]]*\\)[0-9.]*/\\1#{new_ver}/g' redhat/rdma-core.spec suse/rdma-core.spec")
+            @repo.run("sed -i -e 's/\\(Version:[[:space:]]*\\)[0-9.]\\+/\\1#{new_ver}/g' redhat/rdma-core.spec suse/rdma-core.spec")
             @repo.run("sed -i -e 's/\\([sS][eE][tT](PACKAGE_VERSION[[:space:]]*\"\\)[0-9.]*\"/\\1#{new_ver}\"/g' CMakeLists.txt")
 
-            @repo.run("cat <<EOF > debian/changelog.new
+            case opts[:rel_type]
+            when :stable
+                @repo.run("cat <<EOF > debian/changelog.new
 rdma-core (#{new_ver}-1) unstable; urgency=low
 
   * New upstream release.
@@ -41,16 +88,22 @@ rdma-core (#{new_ver}-1) unstable; urgency=low
 $(cat debian/changelog)
 EOF
 mv debian/changelog.new debian/changelog")
+            when :major
+                @repo.run("sed -i -e 's/^rdma-core (#{rel_ver}-1)/rdma-core (#{new_ver}-1)/' debian/changelog")
+            end
 
             # Add and commit
             @repo.runGit("add  redhat/rdma-core.spec suse/rdma-core.spec CMakeLists.txt debian/changelog")
-            @repo.runGit("commit -m 'Bump to version #{new_ver}' --verbose --edit --signoff")
+            @repo.runGitInteractive("commit -m '#{commit_msg} #{new_ver}' --verbose --edit --signoff")
             if $? != 0 then
                 raise("Failed to commit on branch #{local_branch}")
             end
-            @repo.runGit("tag -a -s v#{new_ver} --edit -F #{tag_path}")
-            if $? != 0 then
-                raise("Failed to tag branch #{local_branch}")
+
+            if opts[:rel_type] == :stable
+                @repo.runGitInteractive("tag -a -s v#{rel_ver} --edit -F #{tag_path}")
+                if $? != 0 then
+                    raise("Failed to tag branch #{local_branch}")
+                end
             end
             `rm -f #{tag_path}`
         end

data/lib/branch.rb

@@ -54,7 +54,7 @@ module GitMaintain
             opts[:no_travis] = false
             opts[:all] = false
             opts[:check_only] = false
-            opts[:no_fetch] = false
+            opts[:fetch] = nil
             opts[:watch] = false
 
             optsParser.on("-v", "--base-version [MIN_VER]", Integer, "Older release to consider.") {
@@ -70,8 +70,8 @@ module GitMaintain
             end
 
             if NO_FETCH_ACTIONS.index(action) == nil
-                optsParser.on("--no-fetch", "Skip fetch of stable repo.") {
-                    |val| opts[:no_fetch] = true}
+                optsParser.on("--[no-]fetch", "Enable/Disable fetch of stable repo.") {
+                    |val| opts[:fetch] = val}
             end
 
             case action
@@ -122,9 +122,13 @@ module GitMaintain
         def self.execAction(opts, action)
             repo   = Repo::load()
             travis = TravisChecker::load(repo)
+            opts[:repo] = repo
+            opts[:travis] = travis
+            brClass = GitMaintain::getClass(self, repo.name)
 
-            if NO_FETCH_ACTIONS.index(action) == nil && opts[:no_fetch] == false then
-                repo.stableUpdate()
+            if NO_FETCH_ACTIONS.index(action) == nil && opts[:fetch] != false then
+                GitMaintain::log(:INFO, "Fetching stable repo")
+                repo.stableUpdate(opts[:fetch])
             end
 
             branchList=[]
@@ -154,13 +158,24 @@ module GitMaintain
 
             loop do
                 system("clear; date") if opts[:watch] != false
+
+                res=[]
+
+                # Iterate concerned on all branches
                 branchList.each(){|branch|
                     if NO_CHECKOUT_ACTIONS.index(action) == nil  then
                         GitMaintain::log(:INFO, "Working on #{branch.verbose_name}")
                         branch.checkout()
                     end
-                    branch.send(action, opts)
+                    res << branch.send(action, opts)
                 }
+
+                # Run epilogue (if it exists)
+                begin
+                    brClass.send(action.to_s() + "_epilogue", opts, res)
+                rescue NoMethodError => e
+                end
+
                 break if opts[:watch] == false
                 sleep(opts[:watch])
                 travis.emptyCache()
@@ -189,10 +204,15 @@ module GitMaintain
             @head          = @repo.runGit("rev-parse --verify --quiet #{@local_branch}")
             @remote_ref    = "#{@repo.stable_repo}/#{@remote_branch}"
             @stable_head   = @repo.runGit("rev-parse --verify --quiet #{@remote_ref}")
-            @stable_base   = @repo.findStableBase(@local_branch)
+            case @branch_type
+            when :std
+                @stable_base   = @repo.findStableBase(@local_branch)
+            when :user_specified
+                @stable_base   = @remote_ref
+            end
         end
         attr_reader :version, :local_branch, :head, :remote_branch, :remote_ref, :stable_head,
-                    :verbose_name, :exists
+                    :verbose_name, :exists, :stable_base
 
         def log(lvl, str)
             GitMaintain::log(lvl, str)
@@ -222,7 +242,7 @@ module GitMaintain
             opts[:commits].each(){|commit|
                 prev_head=@repo.runGit("rev-parse HEAD")
                 log(:INFO, "Applying #{@repo.getCommitHeadline(commit)}")
-                @repo.runGit("cherry-pick #{commit}")
+                @repo.runGitInteractive("cherry-pick #{commit}")
                 if $? != 0 then
                     log(:WARNING, "Cherry pick failure. Starting bash for manual fixes. Exit shell to continue")
 			        @repo.runBash()
@@ -295,7 +315,7 @@ module GitMaintain
 
             rep = GitMaintain::checkLog(opts, merge_branch, @local_branch, "merge")
             if rep == "y" then
-                @repo.runGit("merge #{merge_branch}")
+                @repo.runGitInteractive("merge #{merge_branch}")
                 if $? != 0 then
                     log(:WARNING, "Merge failure. Starting bash for manual fixes. Exit shell to continue")
 			        @repo.runBash()
@@ -312,8 +332,17 @@ module GitMaintain
                 log(:INFO, "Nothing to push")
                 return
             end
+            return "#{@local_branch}:#{@local_branch}"
+        end
+
+        def self.push_epilogue(opts, branches)
+            # Compact to remove empty entries
+            branches.compact!()
+
+            return if branches.length == 0
 
-           @repo.runGit("push #{opts[:push_force] == true ? "-f" : ""} #{@repo.valid_repo} #{@local_branch}")
+            opts[:repo].runGit("push #{opts[:push_force] == true ? "-f" : ""} "+
+                               "#{opts[:repo].valid_repo} #{branches.join(" ")}")
         end
 
         # Monitor the build status on Travis
@@ -325,7 +354,7 @@ module GitMaintain
                 suff= " started at #{@travis.getValidTS(head)}"
             end
             log(:INFO, "Status for v#{@version}: " + st + suff)
-            if st == "failed" && opts[:watch] == false
+            if (st == "failed" || st == "errored") && opts[:watch] == false
                 rep = "y"
                 suff=""
                 while rep == "y"
@@ -364,13 +393,21 @@ module GitMaintain
 
             rep = GitMaintain::checkLog(opts, @local_branch, @remote_ref, "submit")
             if rep == "y" then
-                @repo.runGit("push #{@repo.stable_repo} #{@local_branch}:#{@remote_branch}")
+                return "#{@local_branch}:#{@remote_branch}"
             else
                 log(:INFO, "Skipping push to stable")
                 return
             end
         end
 
+
+        def self.push_stable_epilogue(opts, branches)
+            # Compact to remove empty entries
+            branches.compact!()
+
+            return if branches.length == 0
+            opts[:repo].runGit("push #{opts[:repo].stable_repo} #{branches.join(" ")}")
+        end
          # Monitor the build status of the stable branch on Travis
         def monitor_stable(opts)
             st = @travis.getStableState(@stable_head)
@@ -458,13 +495,13 @@ module GitMaintain
 
 	        # Grab the subject, since commit sha1 is different between branches we
 	        # have to look it up based on subject.
-	        subj=@repo.runGit("log -1 --pretty=\"%s\" #{commit}")
+	        subj=@repo.getCommitSubj(commit)
 	        if $? != 0 then
 		        return false
 	        end
 
 	        # Try and find if there's a commit with given subject the hard way
-	        @repo.runGit("log --pretty=\"%H\" -F --grep \"#{subj}\" "+
+	        @repo.runGit("log --pretty=\"%H\" -F --grep \"#{subj.gsub("\"", '\\"')}\" "+
                          "#{@stable_base}..HEAD").split("\n").each(){|cmt|
                 cursubj=@repo.runGit("log -1 --format=\"%s\" #{cmt}")
                 if cursubj = subj then
@@ -512,7 +549,7 @@ module GitMaintain
         end
 
         def pick_one(commit)
-            @repo.runGit("cherry-pick --strategy=recursive -Xpatience -x #{commit} &> /dev/null")
+            @repo.runGitInteractive("cherry-pick --strategy=recursive -Xpatience -x #{commit} &> /dev/null")
 	        return if  $? == 0
             if @repo.runGit("status -uno --porcelain | wc -l") == "0" then
 			    @repo.runGit("reset --hard")
@@ -522,7 +559,7 @@ module GitMaintain
 		    # That didn't work? Let's try that with every variation of the commit
 		    # in other stable trees.
             @repo.find_alts(commit).each(){|alt_commit|
-			    @repo.runGit("cherry-pick --strategy=recursive -Xpatience -x #{alt_commit} &> /dev/null")
+			    @repo.runGitInteractive("cherry-pick --strategy=recursive -Xpatience -x #{alt_commit} &> /dev/null")
 			    if $? == 0 then
 				    return
 			    end
@@ -530,7 +567,7 @@ module GitMaintain
             }
 		    # Still no? Let's go back to the original commit and hand it off to
 		    # the user.
-		    @repo.runGit("cherry-pick --strategy=recursive -Xpatience -x #{commit} &> /dev/null")
+		    @repo.runGitInteractive("cherry-pick --strategy=recursive -Xpatience -x #{commit} &> /dev/null")
             raise CherryPickErrorException.new("Failed to cherry pick commit #{commit}", commit)
 	        return false
         end
@@ -571,7 +608,7 @@ module GitMaintain
         end
 
         def steal_one(opts, commit)
-		    subj=@repo.runGit("log -1 --format=\"%s\" #{commit}")
+		    subj=@repo.getCommitSubj(commit)
             subj.gsub!(/"/, '\"')
 		    msg=''
 
@@ -585,8 +622,10 @@ module GitMaintain
                 return true
 		    end
 
+            log(:VERBOSE, "Found relevant commit #{@repo.getCommitHeadline(commit)}")
 		    if is_in_tree?(orig_cmt) == true
 		        # Commit is already in the stable branch, skip
+                log(:VERBOSE, "Commit is already in tree")
                 return true
 		    end
 

data/lib/common.rb

@@ -59,21 +59,21 @@ module GitMaintain
     end
     module_function :registerCustom
 
-    def getCustom(repo_name)
-        return @@custom_classes[repo_name]
-    end
-    module_function :getCustom
-
-    def loadClass(default_class, repo_name, *more)
+    def getClass(default_class, repo_name = File.basename(Dir.pwd()))
         custom = @@custom_classes[repo_name]
         if custom != nil && custom[default_class] != nil then
             log(:DEBUG,"Detected custom #{default_class} class for repo '#{repo_name}'")
-            return custom[default_class].new(*more)
+            return custom[default_class]
         else
             log(:DEBUG,"Detected NO custom #{default_class} classes for repo '#{repo_name}'")
-            return default_class.new(*more)
+            return default_class
         end
     end
+    module_function :getClass
+
+    def loadClass(default_class, repo_name, *more)
+        return GitMaintain::getClass(default_class, repo_name).new(*more)
+    end
     module_function :loadClass
 
     # Check that the constructor was called through loadClass
@@ -97,8 +97,14 @@ module GitMaintain
     def setOpts(action, optsParser, opts)
          ACTION_CLASS.each(){|x|
             next if x::ACTION_LIST.index(action) == nil
-            next if x.singleton_methods().index(:set_opts) == nil
-            x.set_opts(action, optsParser, opts)
+            if x.singleton_methods().index(:set_opts) != nil then
+                x.set_opts(action, optsParser, opts)
+            end
+            # Try to add repo specific opts
+            y = getClass(x)
+            if x != y && y.singleton_methods().index(:set_opts) != nil then
+                y.set_opts(action, optsParser, opts)
+            end
             break
         }
     end
@@ -108,6 +114,12 @@ module GitMaintain
         ACTION_CLASS.each(){|x|
             next if x.singleton_methods().index(:check_opts) == nil
             x.check_opts(opts)
+
+            # Try to add repo specific opts
+            y = getClass(x)
+            if x != y && y.singleton_methods().index(:check_opts) != nil then
+                y.check_opts(opts)
+            end
         }
     end
     module_function :checkOpts

data/lib/repo.rb

@@ -6,11 +6,13 @@ module GitMaintain
 
         ACTION_LIST = [
             :list_branches,
+            :summary,
             # Internal commands for completion
             :list_suffixes, :submit_release
         ]
         ACTION_HELP = [
             "* submit_release: Push the to stable and create the release packages",
+            "* summary: Displays a summary of the configuration and the branches git-maintain sees"
         ]
 
         def self.load(path=".")
@@ -47,10 +49,11 @@ module GitMaintain
             if path == nil
                 @path = Dir.pwd()
             end
+            @name = File.basename(@path)
 
-            @valid_repo = runGit("config maintain.valid-repo 2> /dev/null").chomp()
+            @valid_repo = getGitConfig("maintain.valid-repo")
             @valid_repo = @@VALID_REPO if @valid_repo == ""
-            @stable_repo = runGit("config maintain.stable-repo 2>/dev/null").chomp()
+            @stable_repo = getGitConfig("maintain.stable-repo")
             @stable_repo = @@STABLE_REPO if @stable_repo == ""
 
             @remote_valid=runGit("remote -v | egrep '^#{@valid_repo}' | grep fetch |
@@ -58,10 +61,22 @@ module GitMaintain
             @remote_stable=runGit("remote -v | egrep '^#{@stable_repo}' | grep fetch |
                                       awk '{ print $2}' | sed -e 's/.*://' -e 's/\\.git//'")
 
-            @branch_format_raw = runGit("config maintain.branch-format 2> /dev/null").chomp()
+            @auto_fetch = getGitConfig("maintain.autofetch")
+            case @auto_fetch
+            when ""
+                @auto_fetch = nil
+            when "true", "yes", "on"
+                @auto_fetch = true
+            when "false", "no", "off"
+                @auto_fetch = false
+            else
+                raise("Invalid value '#{@auto_fetch}' in git config for maintain.autofetch")
+            end
+
+            @branch_format_raw = getGitConfig("maintain.branch-format")
             @branch_format = Regexp.new(/#{@branch_format_raw}/)
-            @stable_branch_format = runGit("config maintain.stable-branch-format 2> /dev/null").chomp()
-            @stable_base_format = runGit("config maintain.stable-base-format 2> /dev/null").chomp()
+            @stable_branch_format = getGitConfig("maintain.stable-branch-format")
+            @stable_base_format = getGitConfig("maintain.stable-base-format")
 
             @stable_base_patterns=
                 runGit("config --get-regexp   stable-base | egrep '^stable-base\.' | "+
@@ -70,8 +85,22 @@ module GitMaintain
                 m[y[0]] = y[1]
                 m
             }
+
+            @mail_format = getGitConfig("maintain.mail-format")
+            if @mail_format == "" then
+                @mail_format = :imap_send
+            else
+                # Check that the format is valid
+                case @mail_format
+                when "imap_send", "send_email"
+                else
+                    raise("Invalid mail-format #{@mail_format}")
+                end
+
+                @mail_format = @mail_format.to_sym()
+            end
         end
-        attr_reader :path, :remote_valid, :remote_stable, :valid_repo, :stable_repo
+        attr_reader :path, :name, :remote_valid, :remote_stable, :valid_repo, :stable_repo
 
         def log(lvl, str)
             GitMaintain::log(lvl, str)
@@ -83,11 +112,18 @@ module GitMaintain
         def runSystem(cmd)
             return system("cd #{@path} && #{cmd}")
         end
+
         def runGit(cmd)
             log(:DEBUG, "Called from #{caller[1]}")
             log(:DEBUG, "Running git command '#{cmd}'")
             return `git --work-tree=#{@path} #{cmd}`.chomp()
         end
+        def runGitInteractive(cmd)
+            log(:DEBUG, "Called from #{caller[1]}")
+            log(:DEBUG, "Running interactive git command '#{cmd}'")
+            return system("git --work-tree=#{@path} #{cmd}")
+        end
+
         def runGitImap(cmd)
             return `export GIT_ASKPASS=$(dirname $(dirname $(which git)))/lib/git-core/git-gui--askpass;
                   if [ ! -f $GIT_ASKPASS ]; then
@@ -97,6 +133,9 @@ module GitMaintain
                   	export GIT_ASKPASS=/usr/lib/ssh/ssh-askpass;
                   fi; git --work-tree=#{@path} imap-send #{cmd}`
         end
+        def getGitConfig(entry)
+            return runGit("config #{entry} 2> /dev/null").chomp()
+        end
 
         def runBash()
             runSystem("bash")
@@ -111,8 +150,13 @@ module GitMaintain
         def getCommitHeadline(sha)
             return runGit("show --format=oneline --no-patch --no-decorate #{sha}")
         end
+        def getCommitSubj(sha)
+            return runGit("log -1 --pretty=\"%s\" #{sha}")
+        end
 
-        def stableUpdate()
+        def stableUpdate(fetch=nil)
+            fetch = @auto_fetch if fetch == nil
+            return if fetch == false
             log(:VERBOSE, "Fetching stable updates...")
             runGit("fetch #{@stable_repo}")
         end
@@ -173,9 +217,9 @@ module GitMaintain
                 mail_path=`mktemp`.chomp()
                 mail = File.open(mail_path, "w+")
                 mail.puts "From " + runGit("rev-parse HEAD") + " " + `date`.chomp()
-                mail.puts "From: " + runGit("config user.name") +
-                          " <" + runGit("config user.email") +">"
-                mail.puts "To: " + runGit("config patch.target")
+                mail.puts "From: " + getGitConfig("user.name") +
+                          " <" + getGitConfig("user.email") +">"
+                mail.puts "To: " + getGitConfig("patch.target")
                 mail.puts "Date: " + `date -R`.chomp()
 
                 if new_tags.length > 4 then
@@ -187,8 +231,8 @@ module GitMaintain
                 else
                     mail.puts "Subject: [ANNOUNCE] " + File.basename(@path) + " " +
                               (new_tags.length > 1 ?
-                                   (new_tags[0 .. -2].join(", ") + " and " + new_tags[-1] + " have ") :
-                                   (new_tags.join(" ") + " has ")) +
+                                   (new_tags[0 .. -2].join(", ") + " and " + new_tags[-1] + " have") :
+                                   (new_tags.join(" ") + " has")) +
                               " been tagged/released"
                     mail.puts ""
                 end
@@ -210,7 +254,14 @@ module GitMaintain
                 mail.puts "https://github.com/#{@remote_stable}/releases"
                 mail.close()
 
-                puts runGitImap("< #{mail_path}; rm -f #{mail_path}")
+                case @mail_format
+                when :imap_send
+                    puts runGitImap("< #{mail_path}")
+                when :send_email
+                    run("cp #{mail_path} announce-release.eml")
+                    log(:INFO, "Generated annoucement email in #{@path}/announce-release.eml")
+                end
+                run("rm -f #{mail_path}")
             end
 
             log(:WARNING, "Last chance to cancel before submitting")
@@ -255,7 +306,52 @@ module GitMaintain
         def submit_release(opts)
             submitReleases(opts)
         end
-
+        def summary(opts)
+             log(:INFO, "Configuration summary:")
+             log(:INFO, "Stable remote: #{@@STABLE_REPO}")
+             log(:INFO, "Validation remote: #{@@VALID_REPO}")
+             log(:INFO, "")
+             log(:INFO, "Branch config:")
+             log(:INFO, "Local branch format: /#{@branch_format_raw}/")
+             log(:INFO, "Remote stable branch format: #{@stable_branch_format}")
+             log(:INFO, "Remote stable base format: #{@stable_base_format}")
+
+             if @stable_base_patterns.length > 0 then
+                 log(:INFO, "")
+                 log(:INFO, "Stable base rules:")
+                 @stable_base_patterns.each(){|name, base|
+                     log(:INFO, "\t#{name} -> #{base}")
+                 }
+             end
+             brList = getBranchList(opts[:br_suff])
+             brStList = getStableBranchList()
+
+             if brList.length > 0 then
+                 log(:INFO, "")
+                 log(:INFO, "Local branches:")
+                 brList.each(){|br|
+                     branch = Branch.load(self, br, nil, opts[:branch_suff])
+                     localBr = branch.local_branch
+                     stableBr = @@STABLE_REPO + "/" + branch.remote_branch
+                     stableBase = branch.stable_base
+                     runGit("rev-parse --verify --quiet #{stableBr}")
+                     stableBr = "<MISSING>" if $? != 0 
+                     log(:INFO, "\t#{localBr} -> #{stableBr} (#{stableBase})")
+                     brStList.delete(br)
+                 }
+             end
+
+             if brStList.length > 0 then
+                 log(:INFO, "")
+                 log(:INFO, "Upstream branches:")
+                 brStList.each(){|br|
+                     branch = Branch.load(self, br, nil, opts[:branch_suff])
+                     stableBr = @@STABLE_REPO + "/" + branch.remote_branch
+                     stableBase = branch.stable_base
+                     log(:INFO, "\t<MISSING> -> #{stableBr} (#{stableBase})")
+                 }
+             end
+       end
         def find_alts(commit)
             alts=[]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-maintain
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Nicolas Morey-Chaisemartin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-release