Report workflow failures to VK Teams

NickVolynkin · NickVolynkin · commit 334f7cd3d9be · 2022-08-17T15:46:02.000+07:00
When a workflow fails, a message will be sent to VK Teams, @tt_docs_cicd_reports. This will only work with PRs from original repository, but not from forks. Also, extract webhooks into separate scripts to make separate steps for them. This way, we'll know which step failed: uploading to S3 or running a webhook. Rename BRANCH_NAME to DEPLOYMENT_NAME in scripts and workflows, becase it makes more sense in workflows deploy-custom and destroy-deployment-manually. Update bobheadxi/deployments to version 1, which supports deleting deployments entirely. Resolves #3085
diff --git a/.github/workflows/deploy-branch.yml b/.github/workflows/deploy-branch.yml
@@ -1,4 +1,4 @@
-name: Deploy-branch
+name: Deploy to dev server
 
 on:
   pull_request:
@@ -14,38 +14,63 @@ jobs:
       S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
       TARANTOOL_UPDATE_KEY: ${{secrets.TARANTOOL_UPDATE_KEY}}
       TARANTOOL_UPDATE_URL: ${{secrets.TARANTOOL_DEVELOP_UPDATE_URL}}
+      VKTEAMS_BOT_TOKEN: ${{secrets.VKTEAMS_TARANTOOLBOT_TOKEN}}
     steps:
       - uses: actions/checkout@v2
+        id: checkout
         with:
           submodules: recursive
 
       - name: Fetch submodules
+        id: fetch-submodules
         run: git fetch --recurse-submodules
 
-      - name: Set branch name from source branch
-        run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
+      - name: Set deployment name from source branch
+        id: set-deployment-name
+        run: echo "DEPLOYMENT_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
 
       - name: Start dev server deployment
-        uses: bobheadxi/deployments@v0.5.2
+        uses: bobheadxi/deployments@v1
         id: deployment
         with:
           step: start
           token: ${{secrets.GITHUB_TOKEN}}
-          env: "branch-${{env.BRANCH_NAME}}"
+          env: "branch-${{env.DEPLOYMENT_NAME}}"
           ref: ${{github.head_ref}}
 
       - run: cmake .
+        id: cmake
       - run: make pull-modules
+        id: make-pull-modules
       - run: make build-modules
+        id: make-build-modules
       - run: make json
+        id: make-json
       - run: make json-ru
+        id: make-json-ru
+
       - run: bash upload_output.sh
+        id: upload-output
+      - run: bash webhooks/update_deployment.sh
+        id: update-deployment-webhook
 
       - name: update deployment status
-        uses: bobheadxi/deployments@v0.5.2
+        id: finalize-deployment
+        uses: bobheadxi/deployments@v1
         with:
           step: finish
           token: ${{secrets.GITHUB_TOKEN}}
+          env: "branch-${{env.DEPLOYMENT_NAME}}"
           status: ${{job.status}}
           deployment_id: ${{steps.deployment.outputs.deployment_id}}
-          env_url: ${{secrets.TARANTOOL_HOST}}/doc/${{env.BRANCH_NAME}}/
+          env_url: ${{secrets.TARANTOOL_HOST}}/doc/${{env.DEPLOYMENT_NAME}}/
+
+      - name: Send VK Teams message on failures
+        # bot token won't be accessible in the forks
+        if: ${{ failure() && env.VKTEAMS_BOT_TOKEN != '' }}
+        uses: tarantool/actions/report-job-status@master
+        with:
+          api-url: "https://api.internal.myteam.mail.ru/bot/v1/"
+          bot-token: ${{ env.VKTEAMS_BOT_TOKEN }}
+          chat-id: tt_docs_cicd_reports
+          job-steps: ${{ ToJson(steps) }}
diff --git a/.github/workflows/deploy-custom.yml b/.github/workflows/deploy-custom.yml
@@ -3,7 +3,7 @@ name: Custom-deploy-branch
 on:
   workflow_dispatch:
     inputs:
-      env_name:
+      deployment_name:
         description: 'Enter unique name (version) of deployment'
         required: True
       cartridge:
@@ -40,20 +40,24 @@ jobs:
       S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
       TARANTOOL_UPDATE_KEY: ${{secrets.TARANTOOL_UPDATE_KEY}}
       TARANTOOL_UPDATE_URL: ${{secrets.TARANTOOL_DEVELOP_UPDATE_URL}}
+      VKTEAMS_BOT_TOKEN: ${{secrets.VKTEAMS_TARANTOOLBOT_TOKEN}}
     steps:
       - uses: actions/checkout@v2
+        id: checkout
         with:
           submodules: recursive
 
       - name: Pull submodules
+        id: pull-submodules
         run: |
           git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*"
           git fetch --recurse-submodules
 
-      - name: Update inputs
+      - name: Update workflow inputs
+        id: update-workflow-inputs
         run: |
-          echo "BRANCH_NAME=${{github.event.inputs.env_name}}" >> $GITHUB_ENV
           echo "workaround until actions/runner#655 is fixed"
+          echo "DEPLOYMENT_NAME=${{github.event.inputs.deployment_name}}" >> $GITHUB_ENV
           echo "INPUT_CARTRIDGE=${{github.event.inputs.cartridge}}" >> $GITHUB_ENV
           echo "INPUT_CARTRIDGE_CLI=${{github.event.inputs.cartridge_cli}}" >> $GITHUB_ENV
           echo "INPUT_GRAFANA=${{github.event.inputs.grafana}}" >> $GITHUB_ENV
@@ -63,27 +67,50 @@ jobs:
           echo "INPUT_CPP_DRIVER=${{github.event.inputs.cpp_driver}}" >> $GITHUB_ENV
 
       - name: Start dev server deployment
-        uses: bobheadxi/deployments@v0.5.2
+        uses: bobheadxi/deployments@v1
         id: deployment
         with:
           step: start
           token: ${{secrets.GITHUB_TOKEN}}
-          env: ${{env.BRANCH_NAME}}
+          env: ${{env.DEPLOYMENT_NAME}}
           ref: ${{github.head_ref}}
 
       - run: cmake .
+        id: cmake
       - run: make pull-modules
+        id: make-pull-modules
       - run: make build-modules
+        id: make-build-modules
       - run: make json
+        id: make-json
       - run: make json-ru
+        id: make-json-ru
+
       - run: curl ${{secrets.WAKEUP_URL}} --connect-timeout 300 --retry 3 --retry-delay 30 >> /dev/null
+        id: wake-up-server
+
       - run: bash upload_output.sh
+        id: upload-output
+      - run: bash webhooks/update_deployment.sh
+        id: update-deployment-webhook
 
       - name: update deployment status
-        uses: bobheadxi/deployments@v0.5.2
+        id: finalize-deployment
+        uses: bobheadxi/deployments@v1
         with:
           step: finish
           token: ${{secrets.GITHUB_TOKEN}}
+          env: ${{env.DEPLOYMENT_NAME}}
           status: ${{job.status}}
           deployment_id: ${{steps.deployment.outputs.deployment_id}}
-          env_url: ${{secrets.TARANTOOL_HOST}}/doc/${{env.BRANCH_NAME}}
+          env_url: ${{secrets.TARANTOOL_HOST}}/doc/${{env.DEPLOYMENT_NAME}}
+
+      - name: Send VK Teams message on failures
+        # bot token won't be accessible in the forks
+        if: ${{ failure() && env.VKTEAMS_BOT_TOKEN != '' }}
+        uses: tarantool/actions/report-job-status@master
+        with:
+          api-url: "https://api.internal.myteam.mail.ru/bot/v1/"
+          bot-token: ${{ env.VKTEAMS_BOT_TOKEN }}
+          chat-id: tt_docs_cicd_reports
+          job-steps: ${{ ToJson(steps) }}
diff --git a/.github/workflows/destroy-deployment-manually.yml b/.github/workflows/destroy-deployment-manually.yml
@@ -9,18 +9,40 @@ on:
 jobs:
   destroy-deployment-manually:
     runs-on: ubuntu-latest
+    env:
+      # we only remove deployments from the test site, never from prod
+      TARANTOOL_UPDATE_URL: ${{secrets.TARANTOOL_DEVELOP_UPDATE_URL}}
+      TARANTOOL_UPDATE_KEY: ${{secrets.TARANTOOL_UPDATE_KEY}}
+      VKTEAMS_BOT_TOKEN: ${{secrets.VKTEAMS_TARANTOOLBOT_TOKEN}}
     steps:
+      - uses: actions/checkout@v2
+        id: checkout
+        with:
+          token: "${{ secrets.GITHUB_TOKEN }}"
+
       - name: Update inputs
+        id: update-inputs
         run: |
           echo "DEPLOYMENT_NAME=${{github.event.inputs.deployment_name}}" >> $GITHUB_ENV
           echo "workaround until actions/runner#655 is fixed"
 
       - name: Remove dev server deployment at ${{env.DEPLOYMENT_NAME}}
+        id: delete-deployment-webhook
+        run: bash webhooks/delete_deployment.sh
+
+      - name: Remove GitHub deployment at ${{env.DEPLOYMENT_NAME}}
         uses: strumwolf/delete-deployment-environment@v2
+        id: remove-github-deployment
         with:
           token: "${{ secrets.TARANTOOLBOT_TOKEN }}"
           environment: ${{ env.DEPLOYMENT_NAME }}
-#          onlyRemoveDeployments: true
 
-      - run: |
-          curl -X DELETE -d '{"update_key":"${{secrets.TARANTOOL_UPDATE_KEY}}"}' -H "Content-Type: application/json" ${{secrets.TARANTOOL_DEVELOP_UPDATE_URL}}${{env.DEPLOYMENT_NAME}}/
+      - name: Send VK Teams message on failures
+        # bot token won't be accessible in the forks
+        if: ${{ failure() && env.VKTEAMS_BOT_TOKEN != '' }}
+        uses: tarantool/actions/report-job-status@master
+        with:
+          api-url: "https://api.internal.myteam.mail.ru/bot/v1/"
+          bot-token: ${{ env.VKTEAMS_BOT_TOKEN }}
+          chat-id: tt_docs_cicd_reports
+          job-steps: ${{ ToJson(steps) }}
diff --git a/.github/workflows/destroy-deployment.yml b/.github/workflows/destroy-deployment.yml
@@ -1,35 +1,50 @@
 name: Destroy-deployments
 
+# When a pull request is merged or just closed, remove deployed docs from the dev server
+# and remove the GitHub deployment with the same name.
+
 on:
   pull_request:
     types:
       - closed
 jobs:
   destroy-deployment:
     runs-on: ubuntu-latest
+    env:
+      # we only remove deployments from the test site, never from prod
+      TARANTOOL_UPDATE_URL: ${{secrets.TARANTOOL_DEVELOP_UPDATE_URL}}
+      TARANTOOL_UPDATE_KEY: ${{secrets.TARANTOOL_UPDATE_KEY}}
+      VKTEAMS_BOT_TOKEN: ${{secrets.VKTEAMS_TARANTOOLBOT_TOKEN}}
     steps:
       - uses: actions/checkout@v2
+        id: checkout
         with:
           token: "${{ secrets.GITHUB_TOKEN }}"
 
-      - name: Set branch name from source branch
-        run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
+      - name: Set deployment name from source branch
+        id: set-deployment-name
+        run: echo "DEPLOYMENT_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
 
-      - run: |
-          curl -X DELETE -d '{"update_key":"${{secrets.TARANTOOL_UPDATE_KEY}}"}' -H "Content-Type: application/json" ${{secrets.TARANTOOL_DEVELOP_UPDATE_URL}}${{env.BRANCH_NAME}}/
+      - name: Remove dev server deployment at branch-${{env.DEPLOYMENT_NAME}}
+        id: delete-deployment-webhook
+        run: bash webhooks/delete_deployment.sh
 
-      - name: Remove dev server deployment at branch-${{env.BRANCH_NAME}}
-        uses: bobheadxi/deployments@v0.5.2
-        id: deployment
+      - name: Remove GitHub deployment at branch-${{env.DEPLOYMENT_NAME}}
+        uses: bobheadxi/deployments@v1
+        # remove GH deployment even if webhook failed
+        if: always()
+        id: remove-github-deployment
         with:
-          step: deactivate-env
+          step: delete-env
           token: ${{secrets.GITHUB_TOKEN}}
-          env: "branch-${{env.BRANCH_NAME}}"
+          env: "branch-${{env.DEPLOYMENT_NAME}}"
 
-      - name: Remove translation deployment at translate-${{env.BRANCH_NAME}}
-        uses: bobheadxi/deployments@v0.5.2
-        id: translation
+      - name: Send VK Teams message on failures
+        # bot token won't be accessible in the forks
+        if: ${{ failure() && env.VKTEAMS_BOT_TOKEN != '' }}
+        uses: tarantool/actions/report-job-status@master
         with:
-          step: deactivate-env
-          token: ${{secrets.GITHUB_TOKEN}}
-          env: "translation-${{env.BRANCH_NAME}}"
+          api-url: "https://api.internal.myteam.mail.ru/bot/v1/"
+          bot-token: ${{ env.VKTEAMS_BOT_TOKEN }}
+          chat-id: tt_docs_cicd_reports
+          job-steps: ${{ ToJson(steps) }}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,4 +1,4 @@
-name: Deploy
+name: Deploy to prod
 
 on:
   workflow_dispatch:
@@ -19,29 +19,43 @@ jobs:
       S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
       TARANTOOL_UPDATE_KEY: ${{secrets.TARANTOOL_UPDATE_KEY}}
       TARANTOOL_UPDATE_URL: ${{secrets.TARANTOOL_UPDATE_URL}}
+      DEPLOYMENT_NAME: latest
     steps:
       - uses: actions/checkout@v2
+        id: checkout
         with:
           submodules: recursive
 
       - name: Fetch submodules
+        id: fetch-submodules
         run: git fetch --recurse-submodules
 
       - run: cmake .
+        id: cmake
       - run: make pull-modules
+        id: make-pull-modules
       - run: make build-modules
+        id: make-build-modules
       - run: make json
+        id: make-json
       - run: make json-ru
+        id: make-json-ru
       - run: make pdf
+        id: make-pdf
       - run: make pdf-ru
-      - uses: nelonoel/branch-name@v1.0.1
-      - if:
-          contains('
-          refs/heads/latest
-          refs/heads/2.5
-          refs/heads/2.4
-          refs/heads/2.3
-          refs/heads/2.2
-          refs/heads/1.10
-          ', github.ref)
-        run: bash upload_output.sh
+        id: make-pdf-ru
+
+      - run: bash upload_output.sh
+        id: upload-output
+      - run: bash webhooks/update_deployment.sh
+        id: update-deployment-webhook
+
+      - name: Send VK Teams message on failures
+        # bot token won't be accessible in the forks
+        if: ${{ failure() && env.VKTEAMS_BOT_TOKEN != '' }}
+        uses: tarantool/actions/report-job-status@master
+        with:
+          api-url: "https://api.internal.myteam.mail.ru/bot/v1/"
+          bot-token: ${{ env.VKTEAMS_BOT_TOKEN }}
+          chat-id: tt_docs_cicd_reports
+          job-steps: ${{ ToJson(steps) }}
diff --git a/.gitignore b/.gitignore
@@ -19,6 +19,9 @@ rocks
 # Crowdin API key
 apikey.txt
 
+# secrets for running webhooks locally
+webhooks/.env
+
 # README copied to contributor docs
 /doc/contributing/docs/_includes/README.rst
 
diff --git a/upload_output.sh b/upload_output.sh
@@ -2,10 +2,12 @@
 
 set -xe -o pipefail -o nounset
 
-BRANCH=$BRANCH_NAME
+BRANCH=$DEPLOYMENT_NAME
 ENDPOINT_URL=$S3_ENDPOINT_URL
 S3_PATH=$S3_UPLOAD_PATH
 
+echo "Upload produced documentation outputs to the S3 storage, tarantool/${BRANCH}"
+
 # don't upload the '*.pickle' files
 find output -name '*.pickle' -delete
 
@@ -33,8 +35,3 @@ aws s3 sync --acl public-read output/html/ru/_static $S3_PATH/$BRANCH/ru/_static
 aws s3 sync --acl public-read output/html/ru/_images $S3_PATH/$BRANCH/ru/_images --endpoint-url=$ENDPOINT_URL --delete --size-only
 aws s3 cp --acl public-read output/html/ru/singlehtml.html $S3_PATH/$BRANCH/ru/singlehtml.html --endpoint-url=$ENDPOINT_URL
 fi
-
-curl --fail --show-error \
-    --data '{"update_key":"'"$TARANTOOL_UPDATE_KEY"'"}' \
-    --header "Content-Type: application/json" \
-    --request POST "$TARANTOOL_UPDATE_URL""$BRANCH"/
diff --git a/webhooks/.env-example b/webhooks/.env-example
@@ -0,0 +1,3 @@
+TARANTOOL_UPDATE_URL=
+TARANTOOL_UPDATE_KEY=
+DEPLOYMENT_NAME=
diff --git a/webhooks/delete_deployment.sh b/webhooks/delete_deployment.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -xe -o pipefail -o nounset
+
+echo "Remove doc deployment ${DEPLOYMENT_NAME} from the server"
+
+# testing this locally:
+# source .env && export $(cut -d= -f1 .env) && ./delete_deployment.sh
+
+curl --fail --show-error -v \
+    --data '{"update_key":"'"${TARANTOOL_UPDATE_KEY}"'"}' \
+    --header "Content-Type: application/json" \
+    --request DELETE "${TARANTOOL_UPDATE_URL}""${DEPLOYMENT_NAME}"/
+
diff --git a/webhooks/update_deployment.sh b/webhooks/update_deployment.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+TARANTOOL_UPDATE_URL=`
	`2`	`+TARANTOOL_UPDATE_KEY=`
	`3`	`+DEPLOYMENT_NAME=`