Expose commit-ish to be packaged from pkgVersionFromGit()

Author: anthonyfok

make.go

@@ -105,12 +105,13 @@ type upstream struct {
 	tarPath     string   // path to the downloaded or generated orig tarball tempfile
 	compression string   // compression method, either "gz" or "xz"
 	version     string   // Debian package upstream version number, e.g. 0.0~git20180204.1d24609
+	commitIsh   string   // commit-ish corresponding to upstream version to be packaged
 	firstMain   string   // import path of the first main package within repo, if any
 	vendorDirs  []string // all vendor sub directories, relative to the repo directory
 	repoDeps    []string // the repository paths of all dependencies (e.g. github.com/zyedidia/glob)
 	hasGodeps   bool     // whether the Godeps/_workspace directory exists
 	hasRelease  bool     // whether any release tags exist, for debian/watch
-	isRelease   bool     // whether we are packaging a tagged version or not
+	isRelease   bool     // whether what we end up packaging is a tagged release
 }
 
 func (u *upstream) get(gopath, repo, rev string) error {
@@ -341,7 +342,7 @@ func makeUpstreamSourceTarball(repo, revision string, forcePrerelease bool) (*up
 
 	log.Printf("Determining upstream version number\n")
 
-	u.version, u.hasRelease, u.isRelease, err = pkgVersionFromGit(repoDir, forcePrerelease)
+	u.version, err = pkgVersionFromGit(repoDir, &u, forcePrerelease)
 	if err != nil {
 		return nil, err
 	}

version.go

@@ -21,8 +21,13 @@ var (
 	semverRegexp = regexp.MustCompile(`^v(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`)
 )
 
+// pkgVersionFromGit determines the actual version to be packaged
+// from the git repository status and user preference.
+// Besides returning the Debian upstream version, the "upstream" struct
+// struct fields u.version, u.commitIsh, u.hasRelease and u.isRelease
+// are also set.
 // TODO: also support other VCS
-func pkgVersionFromGit(gitdir string, forcePrerelease bool) (version string, hasRelease, isRelease bool, err error) {
+func pkgVersionFromGit(gitdir string, u *upstream, forcePrerelease bool) (string, error) {
 	var latestTag string
 	var commitsAhead int
 
@@ -31,7 +36,7 @@ func pkgVersionFromGit(gitdir string, forcePrerelease bool) (version string, has
 	cmd.Dir = gitdir
 	if out, err := cmd.Output(); err == nil {
 		latestTag = strings.TrimSpace(string(out))
-		hasRelease = true
+		u.hasRelease = true
 		log.Printf("Found latest tag %q", latestTag)
 
 		if !semverRegexp.MatchString(latestTag) {
@@ -44,11 +49,11 @@ func pkgVersionFromGit(gitdir string, forcePrerelease bool) (version string, has
 		cmd.Dir = gitdir
 		out, err := cmd.Output()
 		if err != nil {
-			return "", true, false, err
+			return "", err
 		}
 		commitsAhead, err = strconv.Atoi(strings.TrimSpace(string(out)))
 		if err != nil {
-			return "", true, false, err
+			return "", err
 		}
 
 		if commitsAhead == 0 {
@@ -58,13 +63,15 @@ func pkgVersionFromGit(gitdir string, forcePrerelease bool) (version string, has
 			log.Printf("INFO: master is ahead of %q by %v commits", latestTag, commitsAhead)
 		}
 
-		version = strings.TrimPrefix(latestTag, "v")
-		isRelease = true
+		u.commitIsh = latestTag
+		u.version = strings.TrimPrefix(latestTag, "v")
 
 		if forcePrerelease {
 			log.Printf("INFO: Force packaging master (prerelease) as requested by user")
+			// Fallthrough to package @master (prerelease)
 		} else {
-			return version, hasRelease, isRelease, nil
+			u.isRelease = true
+			return u.version, nil
 		}
 	}
 
@@ -73,26 +80,26 @@ func pkgVersionFromGit(gitdir string, forcePrerelease bool) (version string, has
 	// 1.0~rc1 < 1.0 < 1.0+b1, as per
 	// https://www.debian.org/doc/manuals/maint-guide/first.en.html#namever
 	mainVer := "0.0~"
-	if hasRelease {
-		mainVer = version + "+"
+	if u.hasRelease {
+		mainVer = u.version + "+"
 	}
 
 	// Find committer date, UNIX timestamp
 	cmd = exec.Command("git", "log", "--pretty=format:%ct", "-n1")
 	cmd.Dir = gitdir
 	lastCommitUnixBytes, err := cmd.Output()
 	if err != nil {
-		return "", hasRelease, isRelease, err
+		return "", err
 	}
 	lastCommitUnix, err := strconv.ParseInt(strings.TrimSpace(string(lastCommitUnixBytes)), 0, 64)
 	if err != nil {
-		return "", hasRelease, isRelease, err
+		return "", err
 	}
 
-	// This results in an output like 4.10.2-232-g9f107c8
+	// This results in an output like "v4.10.2-232-g9f107c8"
 	cmd = exec.Command("git", "describe", "--long", "--tags")
 	cmd.Dir = gitdir
-	lastCommitSha := ""
+	lastCommitHash := ""
 	describeBytes, err := cmd.Output()
 	if err != nil {
 		// In case there are no tags at all, we just use the sha of the current commit
@@ -101,19 +108,21 @@ func pkgVersionFromGit(gitdir string, forcePrerelease bool) (version string, has
 		cmd.Stderr = os.Stderr
 		revparseBytes, err := cmd.Output()
 		if err != nil {
-			return "", hasRelease, isRelease, err
+			return "", err
 		}
-		lastCommitSha = strings.TrimSpace(string(revparseBytes))
+		lastCommitHash = strings.TrimSpace(string(revparseBytes))
+		u.commitIsh = lastCommitHash
 	} else {
 		submatches := describeRegexp.FindSubmatch(describeBytes)
 		if submatches == nil {
-			return "", hasRelease, isRelease, fmt.Errorf("git describe output %q does not match expected format", string(describeBytes))
+			return "", fmt.Errorf("git describe output %q does not match expected format", string(describeBytes))
 		}
-		lastCommitSha = string(submatches[1])
+		lastCommitHash = string(submatches[1])
+		u.commitIsh = strings.TrimSpace(string(describeBytes))
 	}
-	version = fmt.Sprintf("%sgit%s.%s",
+	u.version = fmt.Sprintf("%sgit%s.%s",
 		mainVer,
 		time.Unix(lastCommitUnix, 0).UTC().Format("20060102"),
-		lastCommitSha)
-	return version, hasRelease, isRelease, nil
+		lastCommitHash)
+	return u.version, nil
 }

version_test.go

@@ -42,7 +42,8 @@ func TestSnapshotVersion(t *testing.T) {
 		t.Fatalf("Could not run %v: %v", cmd.Args, err)
 	}
 
-	got, _, _, err := pkgVersionFromGit(tempdir, false)
+	var u upstream
+	got, err := pkgVersionFromGit(tempdir, &u, false)
 	if err != nil {
 		t.Fatalf("Determining package version from git failed: %v", err)
 	}
@@ -52,7 +53,7 @@ func TestSnapshotVersion(t *testing.T) {
 
 	gitCmdOrFatal(t, tempdir, "tag", "-a", "v1", "-m", "release v1")
 
-	got, _, _, err = pkgVersionFromGit(tempdir, false)
+	got, err = pkgVersionFromGit(tempdir, &u, false)
 	if err != nil {
 		t.Fatalf("Determining package version from git failed: %v", err)
 	}
@@ -72,7 +73,7 @@ func TestSnapshotVersion(t *testing.T) {
 		t.Fatalf("Could not run %v: %v", cmd.Args, err)
 	}
 
-	got, _, _, err = pkgVersionFromGit(tempdir, false)
+	got, err = pkgVersionFromGit(tempdir, &u, false)
 	if err != nil {
 		t.Fatalf("Determining package version from git failed: %v", err)
 	}
@@ -92,7 +93,7 @@ func TestSnapshotVersion(t *testing.T) {
 		t.Fatalf("Could not run %v: %v", cmd.Args, err)
 	}
 
-	got, _, _, err = pkgVersionFromGit(tempdir, false)
+	got, err = pkgVersionFromGit(tempdir, &u, false)
 	if err != nil {
 		t.Fatalf("Determining package version from git failed: %v", err)
 	}