Add support for GitHub deployment reference

pkg/services/github.go

@@ -54,6 +54,7 @@ type GitHubDeployment struct {
 	LogURL           string   `json:"logURL,omitempty"`
 	RequiredContexts []string `json:"requiredContexts"`
 	AutoMerge        *bool    `json:"autoMerge,omitempty"`
+	Reference        string   `json:"reference,omitempty"`
 }
 
 type GitHubPullRequestComment struct {
@@ -101,7 +102,7 @@ func (g *GitHubNotification) GetTemplater(name string, f texttemplate.FuncMap) (
 		}
 	}
 
-	var deploymentState, environment, environmentURL, logURL *texttemplate.Template
+	var deploymentState, environment, environmentURL, reference, logURL *texttemplate.Template
 	if g.Deployment != nil {
 		deploymentState, err = texttemplate.New(name).Funcs(f).Parse(g.Deployment.State)
 		if err != nil {
@@ -118,6 +119,11 @@ func (g *GitHubNotification) GetTemplater(name string, f texttemplate.FuncMap) (
 			return nil, err
 		}
 
+		reference, err = texttemplate.New(name).Funcs(f).Parse(g.Deployment.Reference)
+		if err != nil {
+			return nil, err
+		}
+
 		logURL, err = texttemplate.New(name).Funcs(f).Parse(g.Deployment.LogURL)
 		if err != nil {
 			return nil, err
@@ -211,6 +217,13 @@ func (g *GitHubNotification) GetTemplater(name string, f texttemplate.FuncMap) (
 			} else {
 				notification.GitHub.Deployment.AutoMerge = g.Deployment.AutoMerge
 			}
+
+			var referenceData bytes.Buffer
+			if err := reference.Execute(&referenceData, vars); err != nil {
+				return err
+			}
+			notification.GitHub.Deployment.Reference = referenceData.String()
+
 			notification.GitHub.Deployment.RequiredContexts = g.Deployment.RequiredContexts
 		}
 
@@ -327,12 +340,19 @@ func (g gitHubService) Send(notification Notification, _ Destination) error {
 		u := strings.Split(fullNameByRepoURL(notification.GitHub.repoURL), "/")
 		// maximum is 140 characters
 		description := trunc(notification.Message, 140)
+
+		// if no reference is provided, use the revision
+		ref := notification.GitHub.Deployment.Reference
+		if ref == "" {
+			ref = notification.GitHub.revision
+		}
+
 		deployment, _, err := g.client.Repositories.CreateDeployment(
 			context.Background(),
 			u[0],
 			u[1],
 			&github.DeploymentRequest{
-				Ref:              &notification.GitHub.revision,
+				Ref:              &ref,
 				Environment:      &notification.GitHub.Deployment.Environment,
 				RequiredContexts: &notification.GitHub.Deployment.RequiredContexts,
 				AutoMerge:        notification.GitHub.Deployment.AutoMerge,

pkg/services/github_test.go

@@ -113,6 +113,7 @@ func TestGetTemplater_GitHub_Deployment(t *testing.T) {
 			RepoURLPath:  "{{.sync.spec.git.repo}}",
 			RevisionPath: "{{.sync.status.lastSyncedCommit}}",
 			Deployment: &GitHubDeployment{
+				Reference:        "v0.0.1",
 				State:            "success",
 				Environment:      "production",
 				EnvironmentURL:   "https://argoproj.github.io",
@@ -159,6 +160,7 @@ func TestGetTemplater_GitHub_Deployment(t *testing.T) {
 	assert.Equal(t, "https://argoproj.github.io/log", notification.GitHub.Deployment.LogURL)
 	assert.Len(t, notification.GitHub.Deployment.RequiredContexts, 0)
 	assert.Equal(t, &f, notification.GitHub.Deployment.AutoMerge)
+	assert.Equal(t, "v0.0.1", notification.GitHub.Deployment.Reference)
 }
 
 func TestNewGitHubService_GitHubOptions(t *testing.T) {