diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 6aea90ae8..0a9c66294 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -42,6 +42,6 @@ As the name suggests, this workflow cleans up the feature branch infrastructure. ### Bugs -Right now, there is a small bug with the `update-feature-branch.yml` workflow. This workflow conditionally deploys the various stacks depending on what files have changed from a commit. The issue is that the custom filter action compares the PR branch to master for every workflow run. This means that if you make a change to `src/app.ts` in the first commit, but only make changes to files in the `api/` directory in subsequent commits, it will still run the deploy for the worker. +Right now, there is a small bug with the `update-feature-branch.yml` workflow. This workflow conditionally deploys the various stacks depending on what files have changed from a commit. The issue is that the custom filter action compares the PR branch to main for every workflow run. This means that if you make a change to `src/app.ts` in the first commit, but only make changes to files in the `api/` directory in subsequent commits, it will still run the deploy for the worker. For the `deploy-feature-branch.yml` workflow, this will not re-run if the first build when opening a PR fails. This means that subsequent builds of the `update-feature-branch.yml` workflow will also fail. This is due to the fact that the SQS queues would not have been deployed. For now, the workaround is to close and re-open the PR. This will run the `deploy-feature-branch.yml` workflow. diff --git a/.github/workflows/clean-feature-branch.yml b/.github/workflows/clean-feature-branch.yml index e08ae8649..2e0f9fec4 100644 --- a/.github/workflows/clean-feature-branch.yml +++ b/.github/workflows/clean-feature-branch.yml @@ -1,7 +1,7 @@ on: pull_request: branches: - - master + - main types: - closed @@ -32,4 +32,4 @@ jobs: - name: Delete cache run: gh cache delete ${{github.head_ref}} env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/deploy-feature-branch.yml b/.github/workflows/deploy-feature-branch.yml index 1da880844..2404ac9ae 100644 --- a/.github/workflows/deploy-feature-branch.yml +++ b/.github/workflows/deploy-feature-branch.yml @@ -1,7 +1,7 @@ on: pull_request: branches: - - master + - main types: - opened - reopened @@ -40,4 +40,4 @@ jobs: path: | node_modules cdk-infra/node_modules - key: ${{ github.head_ref }} \ No newline at end of file + key: ${{ github.head_ref }} diff --git a/.github/workflows/deploy-stg-ecs.yml b/.github/workflows/deploy-stg-ecs.yml index 55c5630b3..2967c5812 100644 --- a/.github/workflows/deploy-stg-ecs.yml +++ b/.github/workflows/deploy-stg-ecs.yml @@ -1,7 +1,7 @@ on: push: branches: - - "master" + - "main" - "integration" concurrency: group: environment-stg-${{ github.ref }} diff --git a/.github/workflows/deploy-stg-enhanced-webhooks.yml b/.github/workflows/deploy-stg-enhanced-webhooks.yml index 4175f857e..f4d4dd938 100644 --- a/.github/workflows/deploy-stg-enhanced-webhooks.yml +++ b/.github/workflows/deploy-stg-enhanced-webhooks.yml @@ -2,7 +2,7 @@ on: push: paths: ["api/v2/**", "cdk-infra/lib/constructs/api/**", "cdk-infra/utils/**"] branches: - - "master" + - "main" - "integration" concurrency: diff --git a/.github/workflows/deploy-stg-enhanced-worker.yml b/.github/workflows/deploy-stg-enhanced-worker.yml index ba863bfb5..4f3fb2d24 100644 --- a/.github/workflows/deploy-stg-enhanced-worker.yml +++ b/.github/workflows/deploy-stg-enhanced-worker.yml @@ -2,7 +2,7 @@ on: push: paths: ["src/**", "cdk-infra/lib/constructs/worker/**", "Dockerfile.enhanced", "modules/**"] branches: - - 'master' + - 'main' - 'integration' concurrency: diff --git a/.github/workflows/test-oas-page-builder.yml b/.github/workflows/test-oas-page-builder.yml index ab4f769fd..7702f019c 100644 --- a/.github/workflows/test-oas-page-builder.yml +++ b/.github/workflows/test-oas-page-builder.yml @@ -3,10 +3,10 @@ name: CI - OAS Page Builder on: push: branches: - - master + - main pull_request: branches: - - master + - main jobs: # Checks for changes to the modules/oas-page-builder directory diff --git a/.github/workflows/test-persistence.yml b/.github/workflows/test-persistence.yml index 2b64fd2e3..e8514efed 100644 --- a/.github/workflows/test-persistence.yml +++ b/.github/workflows/test-persistence.yml @@ -3,10 +3,10 @@ name: CI-persistence on: push: branches: - - master + - main pull_request: branches: - - master + - main jobs: # Checks for changes to the modules/persistence directory diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 3e06025c0..2c94ee8e0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -3,10 +3,10 @@ name: CI on: push: branches: - - master + - main pull_request: branches: - - master + - main jobs: # Checks for changes outside of /modules directory diff --git a/.github/workflows/update-feature-branch.yml b/.github/workflows/update-feature-branch.yml index 997f94b14..151a8faed 100644 --- a/.github/workflows/update-feature-branch.yml +++ b/.github/workflows/update-feature-branch.yml @@ -1,7 +1,7 @@ on: pull_request: branches: - - master + - main types: - synchronize diff --git a/Dockerfile b/Dockerfile index 7c079ca92..f89fd3ebd 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.6 +ARG SNOOTY_FRONTEND_VERSION=0.15.7 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 505c84034..a01bf9a94 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.6 +ARG SNOOTY_FRONTEND_VERSION=0.15.7 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 f3b2bd7a8..4382caf4d 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.6 +ARG SNOOTY_FRONTEND_VERSION=0.15.7 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 6e5224e91..acf664c4d 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ See the [spec doc](https://docs.google.com/document/d/1XZOuuGmozcLQRSDitx0UWhZzJ ## Branches -Development in this repository can be done via forks or branches. Currently, we support a `master` branch and `meta` branch. In general, the development workflow is to open pull requests against `master`, and to test `master` prior to creating new tags for a release. +Development in this repository can be done via forks or branches. Currently, we support a `main` branch and `meta` branch. In general, the development workflow is to open pull requests against `main`, and to test `main` prior to creating new tags for a release. In general, the git workflow within this repository loosely follows https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow . @@ -134,11 +134,11 @@ In general, the git workflow within this repository loosely follows https://www. `meta` contains various makefiles and .yaml files used for configuration. Changes or additions to/of makefiles and .yaml for publishing purposes should be performed against this branch. -There is no general requirement to keep `meta` up to date with `master` or `integration`. +There is no general requirement to keep `meta` up to date with `main` or `integration`. -### Master +### Main -`master` is treated as a running pre-production feature branch. Changes should not go into master until properly tested for regressions in an acceptance environment. It is an expectation that hotfixes may have to occur on occasion - on such an occasion, a feature branch should be made from the commit hash of the last release tag, and not from the head of master. Master may contain changes that have yet to be fully tested for a production release. +`main` is treated as a running pre-production feature branch. Changes should not go into main until properly tested for regressions in an acceptance environment. It is an expectation that hotfixes may have to occur on occasion - on such an occasion, a feature branch should be made from the commit hash of the last release tag, and not from the head of main. Main may contain changes that have yet to be fully tested for a production release. ### Release Tags @@ -146,11 +146,11 @@ Each release tag represents a presumptive stable release - with the most recent ## Release Process -docs-worker-pool contains various triggers for release to higher environments. Currently, the repository supports an integration environment (reflecting the state of the master branch) and a production environment (reflecting the state of the most recent release tag). +docs-worker-pool contains various triggers for release to higher environments. Currently, the repository supports an integration environment (reflecting the state of the main branch) and a production environment (reflecting the state of the most recent release tag). ### Integration Environment -- Merge a pull request or otherwise push a commit to `master` branch. +- Merge a pull request or otherwise push a commit to `main` branch. - Verify that the deploy-integration-ec2 workflow has executed successfully. ### Production Environment diff --git a/src/job/manifestJobHandler.ts b/src/job/manifestJobHandler.ts index bf1908902..d5c07a4f4 100644 --- a/src/job/manifestJobHandler.ts +++ b/src/job/manifestJobHandler.ts @@ -97,7 +97,7 @@ export class ManifestJobHandler extends JobHandler { throw new InvalidJobError(`Manifest prefix not found for ${this.currJob._id}`); } - // For mut-index usage info, see: https://github.com/mongodb/mut/blob/master/mut/index/main.py#L2 + // For mut-index usage info, see: https://github.com/mongodb/mut/blob/main/mut/index/main.py#L2 this.currJob.deployCommands = [ '. /venv/bin/activate', `cd repos/${getDirectory(this.currJob)}`,