Fail-fast workflows and reports to VK Teams

Use strict settings for fast-failing on errors in bash scripts. Report failed workflows to VK Teams. Rename a few variables for consistency with other doc projects.
tarantool · Aug 18, 2022 · ca3f133 · ca3f133
1 parent db07f42
commit ca3f133
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 20 deletions.
diff --git a/.github/workflows/deploy-branch.yml b/.github/workflows/deploy-branch.yml
@@ -13,29 +13,47 @@ jobs:
       S3_ENDPOINT_URL: ${{secrets.S3_ENDPOINT_URL}}
       S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
       S3_BUCKET: ${{secrets.S3_BUCKET}}
-      INTERNALS_UPDATE_URL: ${{secrets.INTERNALS_DEVELOP_UPDATE_URL}}
-      INTERNALS_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
-      BRANCH_NAME: test
+      DEPLOYMENT_NAME: test
+      VKTEAMS_BOT_TOKEN: ${{secrets.VKTEAMS_TARANTOOLBOT_TOKEN}}
+      TARANTOOL_UPDATE_URL: ${{secrets.INTERNALS_DEVELOP_UPDATE_URL}}
+      TARANTOOL_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
     steps:
       - uses: actions/checkout@v2
+        id: checkout
 
       - 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: make -f ci.mk json
+        id: make-json
       - 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
+        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}}
+
+      - 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-prod.yml b/.github/workflows/deploy-prod.yml
@@ -16,11 +16,28 @@ jobs:
       S3_ENDPOINT_URL: ${{secrets.S3_ENDPOINT_URL}}
       S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
       S3_BUCKET: ${{secrets.S3_BUCKET}}
-      INTERNALS_UPDATE_URL: ${{secrets.INTERNALS_UPDATE_URL}}
-      INTERNALS_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
-      BRANCH_NAME: latest
+      TARANTOOL_UPDATE_URL: ${{secrets.INTERNALS_UPDATE_URL}}
+      TARANTOOL_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
+      DEPLOYMENT_NAME: latest
+      VKTEAMS_BOT_TOKEN: ${{secrets.VKTEAMS_TARANTOOLBOT_TOKEN}}
     steps:
       - uses: actions/checkout@v2
+        id: checkout
 
       - run: make -f ci.mk json
+        id: make-json
       - 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
@@ -2,3 +2,6 @@
 patches/
 
 build/
+
+# secrets for running webhooks locally
+webhooks/.env
diff --git a/upload_output.sh b/upload_output.sh
@@ -1,13 +1,16 @@
 #!/usr/bin/env bash
 
-set -xe
-DOC_DEST="$S3_UPLOAD_PATH/internals/${BRANCH_NAME}"
-# version in doc project and scripts
+set -xe -o pipefail -o nounset
+
+DOC_DEST="$S3_UPLOAD_PATH/internals/${DEPLOYMENT_NAME}"
+# version in doc project and scripts is always 'latest'
+# for both prod and test server, because internals
+# is a single-version project.
 DOC_VERSION=latest
-CHECK_KEY="doc-builds/internals/${BRANCH_NAME}/json/_build_en/json/toctree.fjson"
-UPDATE_KEY=$INTERNALS_UPDATE_KEY
-UPDATE_URL=$INTERNALS_UPDATE_URL
+# directory in the S3 bucket: latest or test.
+CHECK_KEY="doc-builds/internals/${DEPLOYMENT_NAME}/json/_build_en/json/toctree.fjson"
 
+not_exist=false
 aws s3api head-object --bucket ${S3_BUCKET} --key ${CHECK_KEY} --endpoint-url="${S3_ENDPOINT_URL}" || not_exist=true
 if [ $not_exist ]; then
   echo "toctree.json does not exist"
@@ -17,8 +20,3 @@ else
 fi
 
 aws s3 cp build/json "${DOC_DEST}"/json/_build_en/json --endpoint-url="${S3_ENDPOINT_URL}" --recursive --include "*" --exclude "*.jpg" --exclude "*.png" --exclude "*.svg"
-
-curl --fail --show-error \
-    --data '{"update_key":"'"${UPDATE_KEY}"'"}' \
-    --header "Content-Type: application/json" \
-    --request POST "${UPDATE_URL}""${DOC_VERSION}"/
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/update_deployment.sh b/webhooks/update_deployment.sh
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -xe -o pipefail -o nounset
+
+echo "Deploy version ${DEPLOYMENT_NAME} on the server"
+
+# testing this locally:
+# source .env && export $(cut -d= -f1 .env) && ./update_deployment.sh
+
+curl --fail --show-error -v \
+    --data '{"update_key":"'"${TARANTOOL_UPDATE_KEY}"'"}' \
+    --header "Content-Type: application/json" \
+    --request POST "${TARANTOOL_UPDATE_URL}""${DEPLOYMENT_NAME}"/