Merge branch '32776-add-slack-notification-for-scheduled-package-and-qa-jobs' into 'master'

Resolve "Add Slack notification for scheduled `package-and-qa` jobs"

See merge request gitlab-org/gitlab!17796

.gitlab-ci.yml

@@ -8,6 +8,7 @@ stages:
   - review
   - qa
   - post-test
+  - notification
   - pages
 
 variables:
@@ -27,11 +28,12 @@ after_script:
   - date
 
 include:
-  - local: .gitlab/ci/global.gitlab-ci.yml
   - local: .gitlab/ci/cng.gitlab-ci.yml
   - local: .gitlab/ci/docs.gitlab-ci.yml
   - local: .gitlab/ci/frontend.gitlab-ci.yml
+  - local: .gitlab/ci/global.gitlab-ci.yml
   - local: .gitlab/ci/memory.gitlab-ci.yml
+  - local: .gitlab/ci/notifications.gitlab-ci.yml
   - local: .gitlab/ci/pages.gitlab-ci.yml
   - local: .gitlab/ci/qa.gitlab-ci.yml
   - local: .gitlab/ci/reports.gitlab-ci.yml

.gitlab/ci/global.gitlab-ci.yml

@@ -110,6 +110,12 @@
       - $CI_SERVER_HOST == "gitlab.com" && $CI_PROJECT_NAMESPACE == "gitlab-org"
     kubernetes: active
 
+.only-canonical-schedules:
+  only:
+    refs:
+      - schedules@gitlab-org/gitlab
+      - schedules@gitlab-org/gitlab-foss
+
 .use-pg9:
   services:
     - name: postgres:9.6

.gitlab/ci/notifications.gitlab-ci.yml

+.notify:
+  image: alpine
+  stage: notification
+  dependencies: []
+  cache: {}
+  before_script:
+    - apk update && apk add git curl bash
+
+schedule:package-and-qa:notify-success:
+  extends:
+    - .only-canonical-schedules
+    - .notify
+  script:
+    - 'scripts/notify-slack qa-master ":tada: Scheduled QA against `master` passed! :tada: See $CI_PIPELINE_URL." ci_passing'
+  needs: ["schedule:package-and-qa"]
+  when: on_success
+
+schedule:package-and-qa:notify-failure:
+  extends:
+    - .only-canonical-schedules
+    - .notify
+  script:
+    - 'scripts/notify-slack qa-master ":skull_and_crossbones: Scheduled QA against `master` failed! :skull_and_crossbones: See $CI_PIPELINE_URL." ci_failing'
+  needs: ["schedule:package-and-qa"]
+  when: on_failure

.gitlab/ci/qa.gitlab-ci.yml

@@ -38,9 +38,5 @@ schedule:package-and-qa:
   extends:
     - .package-and-qa-base
     - .only-code-qa-changes
-  only:
-    refs:
-      - schedules@gitlab-org/gitlab
-      - schedules@gitlab-org/gitlab-foss
+    - .only-canonical-schedules
   needs: ["build-qa-image", "gitlab:assets:compile"]
-  allow_failure: true

doc/development/pipelines.md

@@ -27,6 +27,7 @@ The current stages are:
 - `review`: This stage includes jobs that deploy the GitLab and Docs Review Apps.
 - `qa`: This stage includes jobs that perform QA tasks against the Review App
   that is deployed in the previous stage.
+- `notification`: This stage includes jobs that sends notifications about pipeline status.
 - `post-test`: This stage includes jobs that build reports or gather data from
   the previous stages' jobs (e.g. coverage, Knapsack metadata etc.).
 - `pages`: This stage includes a job that deploys the various reports as
@@ -191,6 +192,11 @@ subgraph "`qa` stage"
     dast -.-> |depends on| G;
     end
 
+subgraph "`notification` stage"
+    NOTIFICATION1["schedule:package-and-qa:notify-success<br>(on_success)"] -.-> |needs| P;
+    NOTIFICATION2["schedule:package-and-qa:notify-failure<br>(on_failure)"] -.-> |needs| P;
+    end
+
 subgraph "`post-test` stage"
     M
     end

scripts/notify-slack

+#!/bin/bash
+# Sends Slack notification MSG to CI_SLACK_WEBHOOK_URL (which needs to be set).
+# ICON_EMOJI needs to be set to an icon emoji name (without the `:` around it).
+
+CHANNEL=$1
+MSG=$2
+ICON_EMOJI=$3
+
+if [ -z "$CHANNEL" ] || [ -z "$CI_SLACK_WEBHOOK_URL" ] || [ -z "$MSG" ] || [ -z "$ICON_EMOJI" ]; then
+    echo "Missing argument(s) - Use: $0 channel message icon_emoji"
+    echo "and set CI_SLACK_WEBHOOK_URL environment variable."
+else
+    curl -X POST --data-urlencode 'payload={"channel": "#'"$CHANNEL"'", "username": "GitLab QA Bot", "text": "'"$MSG"'", "icon_emoji": "'":$ICON_EMOJI:"'"}' "$CI_SLACK_WEBHOOK_URL"
+fi