Add notification event DEPLOYMENT_STARTED (#5340)

* Add deployment started notification event and related handling Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]> * Add DEPLOYMENT_STARTED event to notifications documentation Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]> --------- Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>
pipe-cd · Nov 15, 2024 · 00463a6 · 00463a6
1 parent d4cdb13
commit 00463a6
Show file tree

Hide file tree

Showing 10 changed files with 843 additions and 240 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/managing-piped/configuring-notifications.md b/docs/content/en/docs-dev/user-guide/managing-piped/configuring-notifications.md
@@ -20,6 +20,7 @@ Below is the list of supporting event names and their groups.
 |-|-|-|-|
 | DEPLOYMENT_TRIGGERED | DEPLOYMENT | <p style="text-align: center;"><input type="checkbox" checked disabled></p> |  |
 | DEPLOYMENT_PLANNED | DEPLOYMENT | <p style="text-align: center;"><input type="checkbox" checked disabled></p> |  |
+| DEPLOYMENT_STARTED | DEPLOYMENT | <p style="text-align: center;"><input type="checkbox" checked disabled></p> |  |
 | DEPLOYMENT_APPROVED | DEPLOYMENT | <p style="text-align: center;"><input type="checkbox" checked disabled></p> |  |
 | DEPLOYMENT_WAIT_APPROVAL | DEPLOYMENT | <p style="text-align: center;"><input type="checkbox" checked disabled></p> |  |
 | DEPLOYMENT_ROLLING_BACK | DEPLOYMENT | <p style="text-align: center;"><input type="checkbox" disabled></p> | PipeCD sends a notification when a deployment is completed, while it does not send a notification when a deployment status changes to DEPLOYMENT_ROLLING_BACK because it is not a completion status. See [#4547](https://github.com/pipe-cd/pipecd/issues/4547) |

diff --git a/pkg/app/piped/controller/scheduler.go b/pkg/app/piped/controller/scheduler.go
@@ -216,6 +216,21 @@ func (s *scheduler) Run(ctx context.Context) error {
 			return err
 		}
 		controllermetrics.UpdateDeploymentStatus(s.deployment, model.DeploymentStatus_DEPLOYMENT_RUNNING)
+
+		// notify the deployment started event
+		users, groups, err := s.getApplicationNotificationMentions(model.NotificationEventType_EVENT_DEPLOYMENT_STARTED)
+		if err != nil {
+			s.logger.Error("failed to get the list of users or groups", zap.Error(err))
+		}
+
+		s.notifier.Notify(model.NotificationEvent{
+			Type: model.NotificationEventType_EVENT_DEPLOYMENT_STARTED,
+			Metadata: &model.NotificationEventDeploymentStarted{
+				Deployment:        s.deployment,
+				MentionedAccounts: users,
+				MentionedGroups:   groups,
+			},
+		})
 	}
 
 	var (

diff --git a/pkg/app/piped/notifier/slack.go b/pkg/app/piped/notifier/slack.go
@@ -271,6 +271,13 @@ func (s *slack) buildSlackMessage(event model.NotificationEvent, webURL string)
 		text = md.Summary
 		generateDeploymentEventData(md.Deployment, md.MentionedAccounts, md.MentionedGroups)
 
+	case model.NotificationEventType_EVENT_DEPLOYMENT_STARTED:
+		md := event.Metadata.(*model.NotificationEventDeploymentStarted)
+		md.MentionedAccounts = append(md.MentionedAccounts, s.config.MentionedAccounts...)
+		md.MentionedGroups = append(md.MentionedGroups, s.config.MentionedGroups...)
+		title = fmt.Sprintf("Deployment for %q was started", md.Deployment.ApplicationName)
+		generateDeploymentEventData(md.Deployment, md.MentionedAccounts, md.MentionedGroups)
+
 	case model.NotificationEventType_EVENT_DEPLOYMENT_WAIT_APPROVAL:
 		md := event.Metadata.(*model.NotificationEventDeploymentWaitApproval)
 		md.MentionedAccounts = append(md.MentionedAccounts, s.config.MentionedAccounts...)

diff --git a/pkg/app/pipedv1/controller/scheduler.go b/pkg/app/pipedv1/controller/scheduler.go
@@ -212,6 +212,21 @@ func (s *scheduler) Run(ctx context.Context) error {
 			return err
 		}
 		controllermetrics.UpdateDeploymentStatus(s.deployment, model.DeploymentStatus_DEPLOYMENT_RUNNING)
+
+		// notify the deployment started event
+		users, groups, err := s.getApplicationNotificationMentions(model.NotificationEventType_EVENT_DEPLOYMENT_STARTED)
+		if err != nil {
+			s.logger.Error("failed to get the list of users or groups", zap.Error(err))
+		}
+
+		s.notifier.Notify(model.NotificationEvent{
+			Type: model.NotificationEventType_EVENT_DEPLOYMENT_STARTED,
+			Metadata: &model.NotificationEventDeploymentStarted{
+				Deployment:        s.deployment,
+				MentionedAccounts: users,
+				MentionedGroups:   groups,
+			},
+		})
 	}
 
 	var (

diff --git a/pkg/app/pipedv1/notifier/slack.go b/pkg/app/pipedv1/notifier/slack.go
@@ -271,6 +271,13 @@ func (s *slack) buildSlackMessage(event model.NotificationEvent, webURL string)
 		text = md.Summary
 		generateDeploymentEventData(md.Deployment, md.MentionedAccounts, md.MentionedGroups)
 
+	case model.NotificationEventType_EVENT_DEPLOYMENT_STARTED:
+		md := event.Metadata.(*model.NotificationEventDeploymentStarted)
+		md.MentionedAccounts = append(md.MentionedAccounts, s.config.MentionedAccounts...)
+		md.MentionedGroups = append(md.MentionedGroups, s.config.MentionedGroups...)
+		title = fmt.Sprintf("Deployment for %q was started", md.Deployment.ApplicationName)
+		generateDeploymentEventData(md.Deployment, md.MentionedAccounts, md.MentionedGroups)
+
 	case model.NotificationEventType_EVENT_DEPLOYMENT_WAIT_APPROVAL:
 		md := event.Metadata.(*model.NotificationEventDeploymentWaitApproval)
 		md.MentionedAccounts = append(md.MentionedAccounts, s.config.MentionedAccounts...)