capita_git 0.1.2 → 0.1.3

data/lib/capita_git/cli.rb

@@ -127,6 +127,15 @@ module CapitaGit
       repo.close_local_branch(feature_branch)
     end
 
+    desc "backport", "Merges changes from a fixbranch into master"
+    def backport(fix_branch=nil)
+      repo = CapitaGit::Repository.open(Dir.pwd)
+      fix_branch = fix_branch.nil? ? repo.current_branch : fix_branch
+
+      log :confirm, "--> Backporting changes from '#{fix_branch}' into 'master'"
+      repo.merge_fixbranch(fix_branch)
+    end
+
     desc "runner", "Generates a Gemfile into the current working directory"
 
     def runner(command)

data/lib/capita_git/man/gitc

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GITC" "5" "January 2011" "GITC 0.1.2" "GITC Manual"
+.TH "GITC" "5" "February 2011" "GITC 0.1.3" "GITC Manual"
 .
 .SH "NAME"
 \fBgitc\fR \- git helper for CAPITA Unternehmensberatung GmbH
@@ -25,6 +25,9 @@
 \fBgitc\fR close [branch]
 .
 .br
+\fBgitc\fR backport [branch]
+.
+.br
 .
 .SH "DESCRIPTION"
 \fBgitc\fR is a git automation tool used by CAPITA Unternehmensberatung GmbH\.
@@ -63,9 +66,13 @@ creates a feature branch
 .
 .TP
 \fIupdate\fR
-updates the feature branch\'s source branch and does a rebase
+updates the feature branch\'s source branch and rebases the feature branch
 .
 .TP
 \fIclose\fR
 closes a feature branch by updating and merging into the source branch
+.
+.TP
+\fIbackport\fR
+merges changes from a fix branch into master
 

data/lib/capita_git/man/gitc-backport

@@ -0,0 +1,25 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GITC\-BACKPORT" "1" "February 2011" "GITC 0.1.3" "GITC Manual"
+.
+.SH "NAME"
+\fBgitc\-backport\fR \- Ports changes from a fix branch into master
+.
+.SH "SYNOPSIS"
+\fBgitc\fR backport
+.
+.br
+.
+.SH "DESCRIPTION"
+\fBgitc backport\fR merges changes of the currently checked out fix branch back into master\.
+.
+.SH "EXAMPLES"
+.
+.TP
+\'gitc backport\'
+called out of the fix branch \'2\.0\-fix\' would result in:
+.
+.br
+(git checkout master && git merge \-m \'Backporting changes of fix branch \'2\.0\-fix\' into master\' 2\.0\-fix)
+

data/lib/capita_git/man/gitc-backport.txt

@@ -0,0 +1,24 @@
+GITC-BACKPORT(1)		  GITC Manual		      GITC-BACKPORT(1)
+
+
+
+NAME
+       gitc-backport - Ports changes from a fix branch into master
+
+SYNOPSIS
+       gitc backport
+
+DESCRIPTION
+       gitc  backport  merges  changes of the currently checked out fix branch
+       back into master.
+
+EXAMPLES
+       'gitc backport'
+	      called out of the fix branch '2.0-fix' would result in:
+	      (git checkout master && git merge -m 'Backporting changes of fix
+	      branch '2.0-fix' into master' 2.0-fix)
+
+
+
+
+GITC 0.1.3			 February 2011		      GITC-BACKPORT(1)

data/lib/capita_git/man/gitc-check

@@ -1,5 +1,32 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GITC\-CHECK" "" "January 2011" "GITC 0.1.2" "GITC Manual"
-
+.TH "GITC\-CHECK" "1" "February 2011" "GITC 0.1.3" "GITC Manual"
+.
+.SH "NAME"
+\fBgitc\-check\fR \- Check for releases and create branches
+.
+.SH "SYNOPSIS"
+\fBgitc\fR check
+.
+.br
+.
+.SH "DESCRIPTION"
+\fBgitc check\fR does everything neccessary to start working with gitc\'s other features\.
+.
+.P
+After displaying basic information about the current git configuration, gitc queries the remote (origin) repository to figure out the latest major and minor release tags\. The tags \fBhave\fR to be of the format
+.
+.IP "\(bu" 4
+\'1\.X\' as a major release tag
+.
+.IP "\(bu" 4
+\'1\.X\.Y\' as a minor release tag
+.
+.IP "" 0
+.
+.P
+gitc then checks for the presence of local and remote fix\-branches for the latest major release number\. Both local and remote fix\-branches are created and linked, based on a checkout of the latest major release tag\. If a fix\-branch already exists on the remote repository, only a tracking local branch will be created\.
+.
+.P
+For example, running gitc check on a repository with tags \'1\.0\', \'1\.1\' and \'1\.1\.1\' will result in the creation of local and remote branch \'1\.1\-fix\'\.

data/lib/capita_git/man/gitc-check.txt

@@ -1,5 +1,37 @@
-GITC-CHECK()			  GITC Manual			  GITC-CHECK()
+GITC-CHECK(1)			  GITC Manual			 GITC-CHECK(1)
 
 
 
-GITC 0.1.2			 January 2011			  GITC-CHECK()
+NAME
+       gitc-check - Check for releases and create branches
+
+SYNOPSIS
+       gitc check
+
+DESCRIPTION
+       gitc  check  does  everything  neccessary  to start working with gitc's
+       other features.
+
+       After displaying basic information about the current git configuration,
+       gitc  queries  the  remote (origin) repository to figure out the latest
+       major and minor release tags. The tags have to be of the format
+
+       o   '1.X' as a major release tag
+
+       o   '1.X.Y' as a minor release tag
+
+
+
+       gitc then checks for the presence of local and remote fix-branches  for
+       the latest major release number. Both local and remote fix-branches are
+       created and linked, based on a checkout of  the	latest	major  release
+       tag.  If  a  fix-branch already exists on the remote repository, only a
+       tracking local branch will be created.
+
+       For example, running gitc check on a repository with tags '1.0',  '1.1'
+       and  '1.1.1'  will  result  in  the creation of local and remote branch
+       '1.1-fix'.
+
+
+
+GITC 0.1.3			 February 2011			 GITC-CHECK(1)

data/lib/capita_git/man/gitc-close

@@ -0,0 +1,41 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GITC\-CLOSE" "1" "February 2011" "GITC 0.1.3" "GITC Manual"
+.
+.SH "NAME"
+\fBgitc\-close\fR \- Closes a feature branch
+.
+.SH "SYNOPSIS"
+\fBgitc\fR close
+.
+.br
+.
+.SH "DESCRIPTION"
+\fBgitc close\fR merges the feature into the source branch\.
+.
+.P
+After performing a \'gitc update\', and bailing out if the update process fails, the feature branche\'s source branch is checked out, the feature branch is merged and finally deleted\.
+.
+.SH "EXAMPLES"
+.
+.TP
+\'gitc close\'
+called out of the feature branch \'jd_master_my\-feature\' would result in:
+.
+.br
+(git checkout master && git pull && git checkout jd_master_my\-feature && git rebase master)
+.
+.br
+(git checkout master && git merge jd_master_my\-feature && git branch \-d jd_master_my\-feature)
+.
+.TP
+\'gitc update\'
+called out of the feature branch \'jd_2\.0\-fix_my\-feature\' would result in:
+.
+.br
+(git checkout 2\.0\-fix && git pull && git checkout jd_2\.0\-fix_my\-feature && git rebase 2\.0\-fix)
+.
+.br
+(git checkout 2\.0\-fix && git merge jd_2\.0\-fix_my\-feature && git branch \-d jd_2\.0\-fix_my\-feature)
+

data/lib/capita_git/man/gitc-close.txt

@@ -0,0 +1,38 @@
+GITC-CLOSE(1)			  GITC Manual			 GITC-CLOSE(1)
+
+
+
+NAME
+       gitc-close - Closes a feature branch
+
+SYNOPSIS
+       gitc close
+
+DESCRIPTION
+       gitc close merges the feature into the source branch.
+
+       After performing a 'gitc update', and bailing out if the update process
+       fails, the feature branche's source branch is checked out, the  feature
+       branch is merged and finally deleted.
+
+EXAMPLES
+       'gitc close'
+	      called  out  of  the feature branch 'jd_master_my-feature' would
+	      result in:
+	      (git checkout  master  &&  git  pull  &&	git  checkout  jd_mas-
+	      ter_my-feature && git rebase master)
+	      (git  checkout  master  && git merge jd_master_my-feature && git
+	      branch -d jd_master_my-feature)
+
+       'gitc update'
+	      called out of the feature branch	'jd_2.0-fix_my-feature'  would
+	      result in:
+	      (git   checkout	2.0-fix   &&   git   pull   &&	 git  checkout
+	      jd_2.0-fix_my-feature && git rebase 2.0-fix)
+	      (git checkout 2.0-fix && git merge jd_2.0-fix_my-feature &&  git
+	      branch -d jd_2.0-fix_my-feature)
+
+
+
+
+GITC 0.1.3			 February 2011			 GITC-CLOSE(1)

data/lib/capita_git/man/gitc-create

@@ -0,0 +1,39 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GITC\-CREATE" "1" "February 2011" "GITC 0.1.3" "GITC Manual"
+.
+.SH "NAME"
+\fBgitc\-create\fR \- Creates a feature branch
+.
+.SH "SYNOPSIS"
+\fBgitc\fR create \fIname\fR [source_branch]
+.
+.br
+.
+.SH "DESCRIPTION"
+\fBgitc create\fR checks out a new local feature branch for the given name\.
+.
+.P
+The resulting feature branch derives from the source_branch, which defaults to the branch gitc is called from, and is named and prefixed with the user\'s initials accordingly\.
+.
+.P
+Feature branches can\'t be created out of existing feature branches!
+.
+.SH "EXAMPLES"
+(git \-\-config user\.name = "John Doe")
+.
+.TP
+\'gitc create my\-feature\'
+called out of the master branch would result in a branch named \'jd_master_my\-feature\'
+.
+.br
+(git checkout \-b jd_master_my\-feature master)
+.
+.TP
+\'gitc create my\-feature\'
+called out of the fix\-branch \'2\.0\-fix\' would result in a branch named \'jd_2\.0\-fix_my\-feature\'
+.
+.br
+(git checkout \-b jd_2\.0\-fix_my\-feature 2\.0\-fix)
+

data/lib/capita_git/man/gitc-create.txt

@@ -0,0 +1,36 @@
+GITC-CREATE(1)			  GITC Manual			GITC-CREATE(1)
+
+
+
+NAME
+       gitc-create - Creates a feature branch
+
+SYNOPSIS
+       gitc create name [source_branch]
+
+DESCRIPTION
+       gitc create checks out a new local feature branch for the given name.
+
+       The  resulting  feature	branch	derives  from the source_branch, which
+       defaults to the branch gitc is called from, and is named  and  prefixed
+       with the user's initials accordingly.
+
+       Feature branches can't be created out of existing feature branches!
+
+EXAMPLES
+       (git --config user.name = "John Doe")
+
+       'gitc create my-feature'
+	      called  out  of the master branch would result in a branch named
+	      'jd_master_my-feature'
+	      (git checkout -b jd_master_my-feature master)
+
+       'gitc create my-feature'
+	      called out of the fix-branch '2.0-fix' would result in a	branch
+	      named 'jd_2.0-fix_my-feature'
+	      (git checkout -b jd_2.0-fix_my-feature 2.0-fix)
+
+
+
+
+GITC 0.1.3			 February 2011			GITC-CREATE(1)

data/lib/capita_git/man/gitc-update

@@ -0,0 +1,38 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GITC\-UPDATE" "1" "February 2011" "GITC 0.1.3" "GITC Manual"
+.
+.SH "NAME"
+\fBgitc\-update\fR \- Update a feature branch
+.
+.SH "SYNOPSIS"
+\fBgitc\fR update
+.
+.br
+.
+.SH "DESCRIPTION"
+\fBgitc update\fR updates the currently checked out feature branch\.
+.
+.P
+Based on the current feature branch\'s name, the determined source branch is checked out and updated via git pull and the feature branch gets rebased with any new changeset from the source branch\. In case of an unsuccessful rebase, the user needs to proceed as normal (e\.g\. resolving conflicts, issuing \'git add \.\' and \'git rebase \-\-continue\')\.
+.
+.P
+Gitc will fail if the source branch doesn\'t exist or is a feature branch itself!
+.
+.SH "EXAMPLES"
+.
+.TP
+\'gitc update\'
+called out of the feature branch \'jd_master_my\-feature\' would result in updating \'master\' and doing a rebase
+.
+.br
+(git checkout master && git pull && git checkout jd_master_my\-feature && git rebase master)
+.
+.TP
+\'gitc update\'
+called out of the feature branch \'jd_2\.0\-fix_my\-feature\' would result in updating \'2\.0\-fix\' and doing a rebase
+.
+.br
+(git checkout 2\.0\-fix && git pull && git checkout jd_2\.0\-fix_my\-feature && git rebase 2\.0\-fix)
+

data/lib/capita_git/man/gitc-update.txt

@@ -0,0 +1,39 @@
+GITC-UPDATE(1)			  GITC Manual			GITC-UPDATE(1)
+
+
+
+NAME
+       gitc-update - Update a feature branch
+
+SYNOPSIS
+       gitc update
+
+DESCRIPTION
+       gitc update updates the currently checked out feature branch.
+
+       Based  on  the  current	feature  branch's  name, the determined source
+       branch is checked out and updated via git pull and the  feature	branch
+       gets  rebased with any new changeset from the source branch. In case of
+       an unsuccessful rebase, the user  needs	to  proceed  as  normal  (e.g.
+       resolving conflicts, issuing 'git add .' and 'git rebase --continue').
+
+       Gitc  will  fail  if  the  source  branch doesn't exist or is a feature
+       branch itself!
+
+EXAMPLES
+       'gitc update'
+	      called out of the feature  branch  'jd_master_my-feature'  would
+	      result in updating 'master' and doing a rebase
+	      (git  checkout  master  &&  git  pull  &&  git  checkout jd_mas-
+	      ter_my-feature && git rebase master)
+
+       'gitc update'
+	      called out of the feature branch	'jd_2.0-fix_my-feature'  would
+	      result in updating '2.0-fix' and doing a rebase
+	      (git   checkout	2.0-fix   &&   git   pull   &&	 git  checkout
+	      jd_2.0-fix_my-feature && git rebase 2.0-fix)
+
+
+
+
+GITC 0.1.3			 February 2011			GITC-UPDATE(1)

data/lib/capita_git/man/gitc.txt

@@ -12,6 +12,7 @@ SYNOPSIS
        gitc create [name] [source_branch]
        gitc update [branch]
        gitc close [branch]
+       gitc backport [branch]
 
 DESCRIPTION
        gitc is a git automation tool used by CAPITA Unternehmensberatung GmbH.
@@ -42,12 +43,16 @@ COMMANDS
 
        create creates a feature branch
 
-       update updates the feature branch's source branch and does a rebase
+       update updates  the feature branch's source branch and rebases the fea-
+	      ture branch
 
-       close  closes  a feature branch by updating and merging into the source
+       close  closes a feature branch by updating and merging into the	source
 	      branch
 
+       backport
+	      merges changes from a fix branch into master
 
 
 
-GITC 0.1.2			 January 2011			       GITC(5)
+
+GITC 0.1.3			 February 2011			       GITC(5)

data/lib/capita_git/repository.rb

@@ -81,11 +81,17 @@ module CapitaGit
     def close_local_branch(branch)
       raise "Source branch '#{branch}' is not a feature branch, can't close!" unless is_local_feature_branch?(branch)
       rebase_local_branch(branch)
-      system "git checkout #{source_branch(branch)}"
+      checkout_local_branch source_branch(branch)
       system "git merge #{branch}"
       system "git branch -d #{branch}"
     end
 
+    def merge_fixbranch(branch)
+      raise "Source branch '#{branch}' is not a fix branch!" unless is_local_fixbranch?(branch)
+      checkout_local_branch 'master'
+      system "git merge -m 'Backporting changes of fix branch \'#{branch}\' into master' #{branch}"
+    end
+
     def has_local_branch?(name)
       !@repository.branches.local.detect { |b| b.full =~ /#{name.gsub('/', '\/')}/ }.nil?
     end
@@ -94,6 +100,10 @@ module CapitaGit
       !name.match(/^#{user_shortcut}/).nil?
     end
 
+    def is_local_fixbranch?(name)
+      local_fixbranch_for_version?(latest_major_release_tag).to_s == name
+    end
+
     def on_branchable_branch?(branch)
       branch == 'master' or not is_local_feature_branch?(branch)
     end

data/lib/capita_git/version.rb

@@ -1,3 +1,3 @@
 module CapitaGit
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/man/gitc-backport.ronn

@@ -0,0 +1,17 @@
+gitc-backport(1) -- Ports changes from a fix branch into master
+=======================================================
+
+## SYNOPSIS
+
+`gitc` backport<br>
+
+## DESCRIPTION
+
+**gitc backport** merges changes of the currently checked out fix branch back into master.
+
+
+## EXAMPLES
+
+* 'gitc backport':
+  called out of the fix branch '2.0-fix' would result in:<br>
+  (git checkout master && git merge -m 'Backporting changes of fix branch '2.0-fix' into master' 2.0-fix)

data/man/gitc-check.ronn

@@ -1,2 +1,23 @@
-HAHA
-====
+gitc-check(1) -- Check for releases and create branches
+=======================================================
+
+## SYNOPSIS
+
+`gitc` check<br>
+
+## DESCRIPTION
+
+**gitc check** does everything neccessary to start working with gitc's other features.
+
+After displaying basic information about the current git configuration, gitc queries the remote (origin)
+repository to figure out the latest major and minor release tags. The tags **have** to be of the format
+
+* '1.X' as a major release tag
+* '1.X.Y' as a minor release tag
+
+gitc then checks for the presence of local and remote fix-branches for the latest major release number. Both
+local and remote fix-branches are created and linked, based on a checkout of the latest major release tag.
+If a fix-branch already exists on the remote repository, only a tracking local branch will be created.
+
+For example, running gitc check on a repository with tags '1.0', '1.1' and '1.1.1' will result in the creation
+of local and remote branch '1.1-fix'.

data/man/gitc-close.ronn

@@ -0,0 +1,25 @@
+gitc-close(1) -- Closes a feature branch
+=======================================================
+
+## SYNOPSIS
+
+`gitc` close<br>
+
+## DESCRIPTION
+
+**gitc close** merges the feature into the source branch.
+
+After performing a 'gitc update', and bailing out if the update process fails, the feature branche's source branch
+is checked out, the feature branch is merged and finally deleted.
+
+## EXAMPLES
+
+* 'gitc close':
+  called out of the feature branch 'jd_master_my-feature' would result in:<br>
+  (git checkout master && git pull && git checkout jd_master_my-feature && git rebase master)<br>
+  (git checkout master && git merge jd_master_my-feature && git branch -d jd_master_my-feature)
+
+* 'gitc update':
+  called out of the feature branch 'jd_2.0-fix_my-feature' would result in:<br>
+  (git checkout 2.0-fix && git pull && git checkout jd_2.0-fix_my-feature && git rebase 2.0-fix)<br>
+  (git checkout 2.0-fix && git merge jd_2.0-fix_my-feature && git branch -d jd_2.0-fix_my-feature)

data/man/gitc-create.ronn

@@ -0,0 +1,27 @@
+gitc-create(1) -- Creates a feature branch
+=======================================================
+
+## SYNOPSIS
+
+`gitc` create <name> [source_branch]<br>
+
+## DESCRIPTION
+
+**gitc create** checks out a new local feature branch for the given name.
+
+The resulting feature branch derives from the source_branch, which defaults to the branch gitc is called from, and
+is named and prefixed with the user's initials accordingly.
+
+Feature branches can't be created out of existing feature branches!
+
+## EXAMPLES
+
+(git --config user.name = "John Doe")
+
+  * 'gitc create my-feature':
+    called out of the master branch would result in a branch named 'jd_master_my-feature'<br>
+    (git checkout -b jd_master_my-feature master)
+
+  * 'gitc create my-feature':
+    called out of the fix-branch '2.0-fix' would result in a branch named 'jd_2.0-fix_my-feature'<br>
+    (git checkout -b jd_2.0-fix_my-feature 2.0-fix)

data/man/gitc-update.ronn

@@ -0,0 +1,26 @@
+gitc-update(1) -- Update a feature branch
+=======================================================
+
+## SYNOPSIS
+
+`gitc` update<br>
+
+## DESCRIPTION
+
+**gitc update** updates the currently checked out feature branch.
+
+Based on the current feature branch's name, the determined source branch is checked out and updated via git pull and
+the feature branch gets rebased with any new changeset from the source branch. In case of an unsuccessful rebase, the
+user needs to proceed as normal (e.g. resolving conflicts, issuing 'git add .' and 'git rebase --continue').
+
+Gitc will fail if the source branch doesn't exist or is a feature branch itself!
+
+## EXAMPLES
+
+  * 'gitc update':
+    called out of the feature branch 'jd_master_my-feature' would result in updating 'master' and doing a rebase<br>
+    (git checkout master && git pull && git checkout jd_master_my-feature && git rebase master)
+
+  * 'gitc update':
+    called out of the feature branch 'jd_2.0-fix_my-feature' would result in updating '2.0-fix' and doing a rebase<br>
+    (git checkout 2.0-fix && git pull && git checkout jd_2.0-fix_my-feature && git rebase 2.0-fix)

data/man/gitc.ronn

@@ -9,6 +9,7 @@ gitc(5) -- git helper for CAPITA Unternehmensberatung GmbH
 `gitc` create [name] [source_branch]<br>
 `gitc` update [branch]<br>
 `gitc` close [branch]<br>
+`gitc` backport [branch]<br>
 
 ## DESCRIPTION
 
@@ -41,7 +42,10 @@ Available commands currently are:
     creates a feature branch
 
   * <update>:
-    updates the feature branch's source branch and does a rebase
+    updates the feature branch's source branch and rebases the feature branch
 
   * <close>:
     closes a feature branch by updating and merging into the source branch
+
+  * <backport>:
+    merges changes from a fix branch into master

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capita_git
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Sebastian Georgi
@@ -120,15 +120,27 @@ files:
 - lib/capita_git/repository.rb
 - lib/capita_git/ui.rb
 - lib/capita_git/version.rb
+- man/gitc-backport.ronn
 - man/gitc-check.ronn
+- man/gitc-close.ronn
+- man/gitc-create.ronn
+- man/gitc-update.ronn
 - man/gitc.ronn
 - test/cli_test.rb
 - test/shoulda_macros.rb
 - test/test_helper.rb
 - lib/capita_git/man/gitc
 - lib/capita_git/man/gitc-check
+- lib/capita_git/man/gitc-close
+- lib/capita_git/man/gitc-update
+- lib/capita_git/man/gitc-create.txt
+- lib/capita_git/man/gitc-backport.txt
 - lib/capita_git/man/gitc-check.txt
+- lib/capita_git/man/gitc-update.txt
 - lib/capita_git/man/gitc.txt
+- lib/capita_git/man/gitc-close.txt
+- lib/capita_git/man/gitc-create
+- lib/capita_git/man/gitc-backport
 has_rdoc: true
 homepage: https://github.com/capita/capita_git
 licenses: []