Add gitbranch and sha into spaces payload

cli/internal/ci/vendors.go

@@ -15,6 +15,12 @@ type Vendor struct {
 	Env vendorEnvs
 	// EvalEnv is key/value map of environment variables that can be used to quickly determine the vendor
 	EvalEnv map[string]string
+
+	// The name of the environment variable that contains the current git sha
+	ShaEnvVar string
+
+	// The name of the environment variable that contains the current checked out branch
+	BranchEnvVar string
 }
 
 // Vendors is a list of common CI/CD vendors (from https://github.com/watson/ci-info/blob/master/vendors.json)
@@ -107,9 +113,11 @@ var Vendors = []Vendor{
 		Env:      vendorEnvs{Any: []string{"EAS_BUILD"}},
 	},
 	{
-		Name:     "GitHub Actions",
-		Constant: "GITHUB_ACTIONS",
-		Env:      vendorEnvs{Any: []string{"GITHUB_ACTIONS"}},
+		Name:         "GitHub Actions",
+		Constant:     "GITHUB_ACTIONS",
+		Env:          vendorEnvs{Any: []string{"GITHUB_ACTIONS"}},
+		ShaEnvVar:    "GITHUB_SHA",
+		BranchEnvVar: "GITHUB_REF_NAME",
 	},
 	{
 		Name:     "GitLab CI",
@@ -224,9 +232,11 @@ var Vendors = []Vendor{
 		Env:      vendorEnvs{Any: []string{"TRAVIS"}},
 	},
 	{
-		Name:     "Vercel",
-		Constant: "VERCEL",
-		Env:      vendorEnvs{Any: []string{"NOW_BUILDER", "VERCEL"}},
+		Name:         "Vercel",
+		Constant:     "VERCEL",
+		Env:          vendorEnvs{Any: []string{"NOW_BUILDER", "VERCEL"}},
+		ShaEnvVar:    "VERCEL_GIT_COMMIT_SHA",
+		BranchEnvVar: "VERCEL_GIT_COMMIT_REF",
 	},
 	{
 		Name:     "Visual Studio App Center",

cli/internal/runsummary/spaces.go

@@ -2,6 +2,8 @@ package runsummary
 
 import (
 	"github.com/vercel/turbo/cli/internal/ci"
+	"github.com/vercel/turbo/cli/internal/env"
+	"github.com/vercel/turbo/cli/internal/scm"
 )
 
 // spacesRunResponse deserialized the response from POST Run endpoint
@@ -19,11 +21,11 @@ type spacesRunPayload struct {
 	Command        string `json:"command,omitempty"`        // the thing that kicked off the turbo run
 	RepositoryPath string `json:"repositoryPath,omitempty"` // where the command was invoked from
 	Context        string `json:"context,omitempty"`        // the host on which this Run was executed (e.g. Github Action, Vercel, etc)
+	GitBranch      string `json:"gitBranch"`
+	GitSha         string `json:"gitSha"`
 
 	// TODO: we need to add these in
 	// originationUser string
-	// gitBranch       string
-	// gitSha          string
 }
 
 // spacesCacheStatus is the same as TaskCacheSummary so we can convert
@@ -57,13 +59,19 @@ func (rsm *Meta) newSpacesRunCreatePayload() *spacesRunPayload {
 	if name := ci.Constant(); name != "" {
 		context = name
 	}
+
+	// Get a list of env vars
+	sha, branch := getStateOfRepo()
+
 	return &spacesRunPayload{
 		StartTime:      startTime,
 		Status:         "running",
 		Command:        rsm.synthesizedCommand,
 		RepositoryPath: rsm.repoPath.ToString(),
 		Type:           "TURBO",
 		Context:        context,
+		GitBranch:      branch,
+		GitSha:         sha,
 	}
 }
 
@@ -94,3 +102,34 @@ func newSpacesTaskPayload(taskSummary *TaskSummary) *spacesTask {
 		Logs:         string(taskSummary.GetLogs()),
 	}
 }
+
+// getStateOfRepo returns the sha and branch when in a git repo
+// Otherwise it should return empty strings right now.
+// We my add handling of other scms and non-git tracking in the future.
+func getStateOfRepo() (string, string) {
+	allEnvVars := env.GetEnvMap()
+
+	var sha string
+	var branch string
+
+	// If we're in CI, try to get the values we need from environment variables
+	if ci.IsCi() {
+		vendor := ci.Info()
+		branchVarName := vendor.BranchEnvVar
+		shaVarName := vendor.ShaEnvVar
+		// Get the values of the vars
+		vars := env.FromKeys(allEnvVars, []string{shaVarName, branchVarName})
+		sha = vars[shaVarName]
+		branch = vars[branchVarName]
+	}
+
+	// Otherwise fallback to using `git`
+	if branch == "" {
+		branch = scm.GetCurrentBranch()
+	}
+	if sha == "" {
+		sha = scm.GetCurrentSha()
+	}
+
+	return sha, branch
+}

cli/internal/scm/scm.go

@@ -7,6 +7,8 @@
 package scm
 
 import (
+	"os/exec"
+
 	"github.com/pkg/errors"
 
 	"github.com/vercel/turbo/cli/internal/turbopath"
@@ -51,3 +53,23 @@ func FromInRepo(repoRoot turbopath.AbsoluteSystemPath) (SCM, error) {
 	}
 	return newFallback(dotGitDir.Dir())
 }
+
+// GetCurrentBranch returns the current branch
+func GetCurrentBranch() string {
+	command := []string{"rev-parse", "--abbrev-ref", "HEAD"}
+	out, err := exec.Command("git", command...).CombinedOutput()
+	if err != nil {
+		return ""
+	}
+	return string(out)
+}
+
+// GetCurrentSha returns the current SHA
+func GetCurrentSha() string {
+	command := []string{"rev-parse", "HEAD"}
+	out, err := exec.Command("git", command...).CombinedOutput()
+	if err != nil {
+		return ""
+	}
+	return string(out)
+}