Update Documentation

rafecolton · Nov 2, 2014 · 77163c7 · 77163c7
1 parent 715595e
commit 77163c7
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 24 deletions.
diff --git a/Documentation/upgrading-zero-to-one.md b/Documentation/upgrading-zero-to-one.md
@@ -30,8 +30,8 @@ project = "my-app"
 excluded = ["spec"]
 tags = [
   "git:branch",
-  "git:rev",
-  "git:short"
+  "git:sha",
+  "git:tag"
 ]
 
 [containers.base]
@@ -67,8 +67,8 @@ project = "my-app"
 excluded = ["spec"]
 tags = [
   "git:branch",
-  "git:rev",
-  "git:short"
+  "git:sha",
+  "git:tag"
 ]
 
 [[container]] # <--- this line changed, used to be [containers.base]

diff --git a/Documentation/writing-a-bobfile-version-zero.md b/Documentation/writing-a-bobfile-version-zero.md
@@ -30,8 +30,8 @@ project = "my-app"
 excluded = ["spec"]
 tags = [
   "git:branch",
-  "git:rev",
-  "git:short"
+  "git:sha",
+  "git:tag"
 ]
 
 [containers.base]
@@ -99,8 +99,8 @@ excluded = ["spec"]
 included = []
 tags = [
   "git:branch",
-  "git:rev",
-  "git:short"
+  "git:sha",
+  "git:tag"
 ]
 ```
 
@@ -134,8 +134,8 @@ The following macro tags are currently available:
 
 * `git`
     - `git:branch` - the git branch of the app repo (`git rev-parse -q --abbrev-ref HEAD`)
-    - `git:rev` - the full git revision of the app repo (`git rev-parse -q HEAD`)
-    - `git:short` - the shortened version of the app repo rev (`git describe --always`)
+    - `git:sha` - the full git sha of the app repo (`git rev-parse -q HEAD`)
+    - `git:tag` - the shortened version of the app repo rev (`git describe --always`)
 
 ## Linting &amp; Building
 

diff --git a/Documentation/writing-a-bobfile.md b/Documentation/writing-a-bobfile.md
@@ -38,8 +38,8 @@ dockercfg_email = "baz@example.com"
 project = "my-app"
 tags = [
   "git:branch",
-  "git:rev",
-  "git:short"
+  "git:sha",
+  "git:tag"
 ]
 
 [[container]]
@@ -99,8 +99,8 @@ dockercfg_email = "baz@example.com"
 project = "my-app"
 tags = [
   "git:branch",
-  "git:rev",
-  "git:short"
+  "git:sha",
+  "git:tag"
 ]
 ```
 
@@ -139,8 +139,8 @@ The following macro tags are currently available:
 
 * `git`
     - `git:branch` - the git branch of the app repo (`git rev-parse -q --abbrev-ref HEAD`)
-    - `git:rev` - the full git revision of the app repo (`git rev-parse -q HEAD`)
-    - `git:short` - the shortened version of the app repo rev (`git describe --always --dirty --tags`)
+    - `git:sha` - the full git sha of the app repo (`git rev-parse -q HEAD`)
+    - `git:tag` - the shortened version of the app repo rev (`git describe --always --dirty --tags`)
 
 ## Linting &amp; Building
 

diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ VERSION_VAR := $(B)/version.VersionString
 BRANCH_VAR := $(B)/version.BranchString
 REPO_VERSION := $(shell git describe --always --dirty --tags)
 REPO_REV := $(shell git rev-parse --sq HEAD)
-REPO_BRANCH := $(shell git rev-parse -q --abbrev-ref HEAD)
+REPO_BRANCH := $(shell git rev-parse -q --abbrev-ref HEAD) # FIXME: will be "HEAD" if not on branch
 GOBUILD_VERSION_ARGS := -ldflags "\
   -X $(REV_VAR) $(REPO_REV) \
   -X $(VERSION_VAR) $(REPO_VERSION) \

diff --git a/analyzer/analyzer.go b/analyzer/analyzer.go
@@ -186,8 +186,8 @@ func ParseAnalysis(analysis Analysis) (*builderfile.Builderfile, error) {
 			Project:    analysis.RepoBasename(),
 			Tags: []string{
 				"git:branch",
-				"git:rev",
-				"git:short",
+				"git:sha",
+				"git:tag",
 				"latest",
 			},
 		}

diff --git a/analyzer/analyzer_test.go b/analyzer/analyzer_test.go
@@ -42,8 +42,8 @@ var _ = Describe("Analysis Parsing", func() {
 					Project:  "fake-repo",
 					Tags: []string{
 						"git:branch",
-						"git:rev",
-						"git:short",
+						"git:sha",
+						"git:tag",
 						"latest",
 					},
 					Dockerfile: "Dockerfile",

diff --git a/parser/tag/tag.go b/parser/tag/tag.go
@@ -55,8 +55,8 @@ func (tag *nullTag) Tag() string {
 }
 
 /*
-Tag, for a special set of macros (currently `git:branch`, `git:rev`,
-& `git:short`) returns git information from the directory in which bob was run.
+Tag, for a special set of macros (currently `git:branch`, `git:sha`,
+& `git:tag`) returns git information from the directory in which bob was run.
 These macros are specified in args["tag"], and to work properly, args["top"]
 must be supplied as well.  If any of the conditions are not met, Tag returns
 "".
@@ -97,7 +97,7 @@ func (g gitexe) branch() string {
 			if string(branch[0]) == "*" {
 				continue
 			}
-			return strings.Replace(branch, " ", "", -1)
+			return strings.Trim(branch, " ")
 		}
 		return branch