diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 4d2719f8c..6aea90ae8 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -2,6 +2,14 @@ This README describes the various workflows defined for the docs-worker-pool repository. +## Releases + +The release process occurs whenever someone releases a specific tag (note: it does not run upon creation of a tag, only release). Three separate workflows are run upon release: + +1. `deploy-prd-ecs.yml` - Builds and deploys the old Autobuilder to prd +2. `deploy-prd-enhanced-webhooks.yml` - Builds and deploys webhooks (GitHub and Slack handlers) for the enhanced Autobuilder +3. `deploy-prd-enhanced-worker.yml` - Builds and deploys the Autobuilder worker to prd + ## Feature Branch Deploys The feature branch deploy process occurs whenever a developer opens a pull request. It consists of three separate workflows: diff --git a/.github/workflows/deploy-prd-ecs.yml b/.github/workflows/deploy-prd-ecs.yml index c6e96b9a2..68c751c87 100644 --- a/.github/workflows/deploy-prd-ecs.yml +++ b/.github/workflows/deploy-prd-ecs.yml @@ -1,7 +1,6 @@ on: - push: - tags: - - 'v*' + release: + types: [released] concurrency: group: environment-prd-${{ github.ref }} cancel-in-progress: true diff --git a/.github/workflows/deploy-prd-enhanced-webhooks.yml b/.github/workflows/deploy-prd-enhanced-webhooks.yml index 6b0086fac..fc45d7d0c 100644 --- a/.github/workflows/deploy-prd-enhanced-webhooks.yml +++ b/.github/workflows/deploy-prd-enhanced-webhooks.yml @@ -1,8 +1,6 @@ on: - push: - tags: - - 'v*' - + release: + types: [released] concurrency: group: environment-prd-enhanced-webhooks-${{ github.ref }} cancel-in-progress: true diff --git a/.github/workflows/deploy-prd-enhanced-worker.yml b/.github/workflows/deploy-prd-enhanced-worker.yml index 90676eb1c..10eb08325 100644 --- a/.github/workflows/deploy-prd-enhanced-worker.yml +++ b/.github/workflows/deploy-prd-enhanced-worker.yml @@ -1,8 +1,6 @@ on: - push: - tags: - - 'v*' - + release: + types: [released] concurrency: group: environment-prd-enhanced-worker-${{ github.ref }} cancel-in-progress: true diff --git a/Dockerfile b/Dockerfile index ecd4ffded..7c079ca92 100644 --- a/Dockerfile +++ b/Dockerfile @@ -23,7 +23,7 @@ RUN cd ./modules/oas-page-builder \ FROM ubuntu:20.04 ARG WORK_DIRECTORY=/home/docsworker-xlarge ARG SNOOTY_PARSER_VERSION=0.15.2 -ARG SNOOTY_FRONTEND_VERSION=0.15.4 +ARG SNOOTY_FRONTEND_VERSION=0.15.6 ARG MUT_VERSION=0.10.7 ARG REDOC_CLI_VERSION=1.2.3 ARG NPM_BASE_64_AUTH diff --git a/Dockerfile.enhanced b/Dockerfile.enhanced index 5eedb5d8c..505c84034 100644 --- a/Dockerfile.enhanced +++ b/Dockerfile.enhanced @@ -23,7 +23,7 @@ RUN cd ./modules/oas-page-builder \ FROM ubuntu:20.04 ARG WORK_DIRECTORY=/home/docsworker-xlarge ARG SNOOTY_PARSER_VERSION=0.15.2 -ARG SNOOTY_FRONTEND_VERSION=0.15.4 +ARG SNOOTY_FRONTEND_VERSION=0.15.6 ARG MUT_VERSION=0.10.7 ARG REDOC_CLI_VERSION=1.2.3 ARG NPM_BASE_64_AUTH diff --git a/Dockerfile.local b/Dockerfile.local index be9a615d7..f3b2bd7a8 100644 --- a/Dockerfile.local +++ b/Dockerfile.local @@ -2,7 +2,7 @@ FROM arm64v8/ubuntu:20.04 as initial ARG NPM_BASE_64_AUTH ARG NPM_EMAIL ARG SNOOTY_PARSER_VERSION=0.15.2 -ARG SNOOTY_FRONTEND_VERSION=0.15.4 +ARG SNOOTY_FRONTEND_VERSION=0.15.6 ARG MUT_VERSION=0.10.7 ARG REDOC_CLI_VERSION=1.2.3 ARG NPM_BASE_64_AUTH diff --git a/README.md b/README.md index ca199904b..6e5224e91 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,8 @@ docs-worker-pool contains various triggers for release to higher environments. C - Create release tags. We currently follow [semver](https://semver.org/) standards. - If you don't have push access, open an issue or otherwise contact a contributor with administrator privileges. -- Verify that the deploy-production-ec2 workflow executed successfully for both job runs across both production instances. +- Create a release associated with the tag using the GitHub UI or by running `gh release create`. +- Verify that the deploy-production-ec2 workflow executed successfully for both job runs across both production instances. The workflow should only run when a release is published. ### Serverless Development