Merge pull request #340 from code-dot-org/pipeline-notify

Notify slack upon pipeline progress

Author: cat5inthecradle

cicd/2-cicd/cicd.template.yml

@@ -326,3 +326,61 @@ Resources:
                     SUBDOMAIN: !If [TargetsMainBranch, "javabuilder-test", !Sub "javabuilder-${GitHubBranch}-test"]
               OutputArtifacts:
                 - Name: integrationTestResultsPOC
+  
+  # Send pipeline events to an SNS topic.
+  # Note: Integration with Slack via AWS ChatBot is configured manually via AWS Console.
+  PipelineNotificationRule:
+    Type: AWS::CodeStarNotifications::NotificationRule
+    Properties:
+      Name: !Sub ${AWS::StackName}-pipeline
+      DetailType: FULL
+      Resource: !Sub "arn:${AWS::Partition}:codepipeline:${AWS::Region}:${AWS::AccountId}:${Pipeline}"
+      EventTypeIds: 
+        # Pipeline events
+        - codepipeline-pipeline-pipeline-execution-failed
+        - codepipeline-pipeline-pipeline-execution-succeeded
+        - codepipeline-pipeline-pipeline-execution-canceled
+        - codepipeline-pipeline-pipeline-execution-superseded
+        - codepipeline-pipeline-pipeline-execution-started
+        - codepipeline-pipeline-pipeline-execution-resumed
+        # Stage Events
+        - codepipeline-pipeline-stage-execution-started
+        - codepipeline-pipeline-stage-execution-succeeded
+        - codepipeline-pipeline-stage-execution-resumed
+        - codepipeline-pipeline-stage-execution-canceled
+        - codepipeline-pipeline-stage-execution-failed
+        # Action Events
+        - codepipeline-pipeline-action-execution-succeeded
+        - codepipeline-pipeline-action-execution-failed
+        - codepipeline-pipeline-action-execution-canceled
+        - codepipeline-pipeline-action-execution-started
+        # Approval Events (we don't use approvals yet)
+        - codepipeline-pipeline-manual-approval-needed
+        - codepipeline-pipeline-manual-approval-failed
+        - codepipeline-pipeline-manual-approval-succeeded
+      Targets: 
+        - TargetType: SNS 
+          TargetAddress: !Ref PipelineNotificationTopic
+
+  PipelineNotificationTopic:
+    Type: AWS::SNS::Topic
+
+  # This policy is necessary for CodePipeline to be allowed to publish to the Topic.
+  PipelineNotificationTopicPolicy:
+    Type: AWS::SNS::TopicPolicy
+    Properties: 
+      Topics:
+        - !Ref PipelineNotificationTopic
+      PolicyDocument:
+        Version: '2012-10-17'
+        Statement:
+        - Sid: AWSCodeStarNotifications_publish
+          Effect: Allow
+          Principal:
+            Service:
+            - codestar-notifications.amazonaws.com
+          Action: SNS:Publish
+          Resource: !Ref PipelineNotificationTopic
+          Condition:
+            StringEquals:
+              aws:SourceAccount: !Ref AWS::AccountId

cicd/README.md

@@ -53,3 +53,7 @@ Finally, all of the above need some Roles to exist in the AWS accounts before we
 
 * "deploy-setup.sh"
 * "setup.template.yml" - AWS resources for the Setup infrastructure
+
+## Opportunities
+
+- Design more granular notifications by calling Slack webhooks _within_ steps.