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/format_json.go

@@ -63,4 +63,5 @@ type nonMonorepoRunSummary struct {
 	EnvMode           util.EnvMode       `json:"envMode"`
 	ExecutionSummary  *executionSummary  `json:"execution,omitempty"`
 	Tasks             []*TaskSummary     `json:"tasks"`
+	GitState          *gitState          `json:"git"`
 }

cli/internal/runsummary/repo_summary.go

@@ -0,0 +1,40 @@
+package runsummary
+
+import (
+	"github.com/vercel/turbo/cli/internal/ci"
+	"github.com/vercel/turbo/cli/internal/env"
+	"github.com/vercel/turbo/cli/internal/scm"
+	"github.com/vercel/turbo/cli/internal/turbopath"
+)
+
+type gitState struct {
+	Sha    string `json:"sha"`
+	Branch string `json:"branch"`
+}
+
+// getGitState 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 getGitState(dir turbopath.AbsoluteSystemPath) *gitState {
+	allEnvVars := env.GetEnvMap()
+
+	gitstate := &gitState{}
+
+	// If we're in CI, try to get the values we need from environment variables
+	if ci.IsCi() {
+		vendor := ci.Info()
+		gitstate.Sha = allEnvVars[vendor.ShaEnvVar]
+		gitstate.Branch = allEnvVars[vendor.BranchEnvVar]
+	}
+
+	dirString := dir.ToString()
+	// Otherwise fallback to using `git`
+	if gitstate.Branch == "" {
+		gitstate.Branch = scm.GetCurrentBranch(dirString)
+	}
+	if gitstate.Sha == "" {
+		gitstate.Sha = scm.GetCurrentSha(dirString)
+	}
+
+	return gitstate
+}

cli/internal/runsummary/run_summary.go

@@ -64,6 +64,7 @@ type RunSummary struct {
 	EnvMode           util.EnvMode       `json:"envMode"`
 	ExecutionSummary  *executionSummary  `json:"execution,omitempty"`
 	Tasks             []*TaskSummary     `json:"tasks"`
+	GitState          *gitState          `json:"git"`
 }
 
 // NewRunSummary returns a RunSummary instance
@@ -105,6 +106,7 @@ func NewRunSummary(
 			EnvMode:           globalEnvMode,
 			Tasks:             []*TaskSummary{},
 			GlobalHashSummary: globalHashSummary,
+			GitState:          getGitState(repoRoot),
 		},
 		ui:                 ui,
 		runType:            runType,

cli/internal/runsummary/spaces.go

@@ -19,11 +19,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 +57,16 @@ func (rsm *Meta) newSpacesRunCreatePayload() *spacesRunPayload {
 	if name := ci.Constant(); name != "" {
 		context = name
 	}
+
 	return &spacesRunPayload{
 		StartTime:      startTime,
 		Status:         "running",
 		Command:        rsm.synthesizedCommand,
 		RepositoryPath: rsm.repoPath.ToString(),
 		Type:           "TURBO",
 		Context:        context,
+		GitBranch:      rsm.RunSummary.GitState.Branch,
+		GitSha:         rsm.RunSummary.GitState.Sha,
 	}
 }
 

cli/internal/scm/scm.go

@@ -7,6 +7,9 @@
 package scm
 
 import (
+	"os/exec"
+	"strings"
+
 	"github.com/pkg/errors"
 
 	"github.com/vercel/turbo/cli/internal/turbopath"
@@ -51,3 +54,27 @@ func FromInRepo(repoRoot turbopath.AbsoluteSystemPath) (SCM, error) {
 	}
 	return newFallback(dotGitDir.Dir())
 }
+
+// GetCurrentBranch returns the current branch
+func GetCurrentBranch(dir string) string {
+	cmd := exec.Command("git", []string{"branch", "--show-current"}...)
+	cmd.Dir = dir
+
+	out, err := cmd.Output()
+	if err != nil {
+		return ""
+	}
+	return strings.TrimRight(string(out), "\n")
+}
+
+// GetCurrentSha returns the current SHA
+func GetCurrentSha(dir string) string {
+	cmd := exec.Command("git", []string{"rev-parse", "HEAD"}...)
+	cmd.Dir = dir
+
+	out, err := cmd.Output()
+	if err != nil {
+		return ""
+	}
+	return strings.TrimRight(string(out), "\n")
+}

turborepo-tests/integration/tests/dry_json/monorepo.t

@@ -73,6 +73,7 @@ Setup
   $ cat tmpjson.log | jq 'keys'
   [
     "envMode",
+    "git",
     "globalCacheInputs",
     "id",
     "packages",

turborepo-tests/integration/tests/dry_json/single_package.t

@@ -82,5 +82,9 @@ Setup
           "globalPassthrough": null
         }
       }
-    ]
+    ],
+    "git": {
+      "sha": "[a-z0-9]+", (re)
+      "branch": "[a-zA-Z0-9]+" (re)
+    }
   }

turborepo-tests/integration/tests/dry_json/single_package_no_config.t

@@ -76,5 +76,9 @@ Setup
           "globalPassthrough": null
         }
       }
-    ]
+    ],
+    "git": {
+      "sha": "[a-z0-9]+", (re)
+      "branch": "[a-zA-Z0-9]+" (re)
+    }
   }

turborepo-tests/integration/tests/dry_json/single_package_with_deps.t

@@ -143,5 +143,9 @@ Setup
           "globalPassthrough": null
         }
       }
-    ]
+    ],
+    "git": {
+      "sha": "[a-z0-9]+", (re)
+      "branch": "[a-zA-Z0-9]+" (re)
+    }
   }

turborepo-tests/integration/tests/run_summary/monorepo.t

@@ -29,7 +29,26 @@ Setup
   $ FIRST=$(/bin/ls .turbo/runs/*.json | head -n1)
   $ SECOND=$(/bin/ls .turbo/runs/*.json | tail -n1)
 
+  $ cat $FIRST | jq 'keys'
+  [
+    "envMode",
+    "execution",
+    "git",
+    "globalCacheInputs",
+    "id",
+    "packages",
+    "tasks",
+    "turboVersion",
+    "version"
+  ]
+
 # some top level run summary validation
+  $ cat $FIRST | jq '.git'
+  {
+    "sha": "[a-z0-9]+", (re)
+    "branch": "[a-zA-Z0-9]+" (re)
+  }
+
   $ cat $FIRST | jq '.tasks | length'
   2
   $ cat $FIRST | jq '.version'

turborepo-tests/integration/tests/run_summary/single-package.t

@@ -29,6 +29,24 @@ Check
     "success"
   ]
 
+  $ cat $SUMMARY | jq 'keys'
+  [
+    "envMode",
+    "execution",
+    "git",
+    "globalCacheInputs",
+    "id",
+    "tasks",
+    "turboVersion",
+    "version"
+  ]
+
+  $ cat $SUMMARY | jq '.git'
+  {
+    "sha": "[a-z0-9]+", (re)
+    "branch": "[a-zA-Z0-9]+" (re)
+  }
+
   $ cat $SUMMARY | jq '.execution.exitCode'
   0
   $ cat $SUMMARY | jq '.execution.attempted'