feat(github): Support GitHub transient environment deployment type

Signed-off-by: ricky-sb <10700079+ricky-sb@users.noreply.github.com>
argoproj · Jan 24, 2024 · 2eab075 · 2eab075
1 parent c02dc5f
commit 2eab075
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 16 deletions.
diff --git a/docs/services/github.md b/docs/services/github.md
@@ -76,6 +76,7 @@ template.app-deployed: |
       logURL: "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true"
       requiredContexts: []
       autoMerge: true
+      transientEnvironment: false
     pullRequestComment:
       content: |
         Application {{.app.metadata.name}} is now running new version of deployments manifests.

diff --git a/pkg/services/github.go b/pkg/services/github.go
@@ -48,12 +48,13 @@ type GitHubStatus struct {
 }
 
 type GitHubDeployment struct {
-	State            string   `json:"state,omitempty"`
-	Environment      string   `json:"environment,omitempty"`
-	EnvironmentURL   string   `json:"environmentURL,omitempty"`
-	LogURL           string   `json:"logURL,omitempty"`
-	RequiredContexts []string `json:"requiredContexts"`
-	AutoMerge        *bool    `json:"autoMerge,omitempty"`
+	State                string   `json:"state,omitempty"`
+	Environment          string   `json:"environment,omitempty"`
+	EnvironmentURL       string   `json:"environmentURL,omitempty"`
+	LogURL               string   `json:"logURL,omitempty"`
+	RequiredContexts     []string `json:"requiredContexts"`
+	AutoMerge            *bool    `json:"autoMerge,omitempty"`
+	TransientEnvironment *bool    `json:"transientEnvironment,omitempty"`
 }
 
 type GitHubPullRequestComment struct {
@@ -211,6 +212,14 @@ func (g *GitHubNotification) GetTemplater(name string, f texttemplate.FuncMap) (
 			} else {
 				notification.GitHub.Deployment.AutoMerge = g.Deployment.AutoMerge
 			}
+
+			if g.Deployment.TransientEnvironment == nil {
+				deploymentTransientEnvironmentDefault := false
+				notification.GitHub.Deployment.TransientEnvironment = &deploymentTransientEnvironmentDefault
+			} else {
+				notification.GitHub.Deployment.TransientEnvironment = g.Deployment.TransientEnvironment
+			}
+
 			notification.GitHub.Deployment.RequiredContexts = g.Deployment.RequiredContexts
 		}
 
@@ -334,10 +343,11 @@ func (g gitHubService) Send(notification Notification, _ Destination) error {
 			u[0],
 			u[1],
 			&github.DeploymentRequest{
-				Ref:              &notification.GitHub.revision,
-				Environment:      &notification.GitHub.Deployment.Environment,
-				RequiredContexts: &notification.GitHub.Deployment.RequiredContexts,
-				AutoMerge:        notification.GitHub.Deployment.AutoMerge,
+				Ref:                  &notification.GitHub.revision,
+				Environment:          &notification.GitHub.Deployment.Environment,
+				RequiredContexts:     &notification.GitHub.Deployment.RequiredContexts,
+				AutoMerge:            notification.GitHub.Deployment.AutoMerge,
+				TransientEnvironment: notification.GitHub.Deployment.TransientEnvironment,
 			},
 		)
 		if err != nil {

diff --git a/pkg/services/github_test.go b/pkg/services/github_test.go
@@ -123,17 +123,19 @@ func TestSend_GitHubService_BadURL(t *testing.T) {
 
 func TestGetTemplater_GitHub_Deployment(t *testing.T) {
 	f := false
+	tr := true
 	n := Notification{
 		GitHub: &GitHubNotification{
 			RepoURLPath:  "{{.sync.spec.git.repo}}",
 			RevisionPath: "{{.sync.status.lastSyncedCommit}}",
 			Deployment: &GitHubDeployment{
-				State:            "success",
-				Environment:      "production",
-				EnvironmentURL:   "https://argoproj.github.io",
-				LogURL:           "https://argoproj.github.io/log",
-				RequiredContexts: []string{},
-				AutoMerge:        &f,
+				State:                "success",
+				Environment:          "production",
+				EnvironmentURL:       "https://argoproj.github.io",
+				LogURL:               "https://argoproj.github.io/log",
+				RequiredContexts:     []string{},
+				AutoMerge:            &f,
+				TransientEnvironment: &tr,
 			},
 		},
 	}
@@ -174,6 +176,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, &tr, notification.GitHub.Deployment.TransientEnvironment)
 }
 
 func TestNewGitHubService_GitHubOptions(t *testing.T) {