From cb4af7956737e225a9429684ca6202ac24f60781 Mon Sep 17 00:00:00 2001 From: Jessica Gadling Date: Tue, 10 Sep 2024 06:40:36 -0700 Subject: [PATCH] feat: add docs for release (#265) * Add convenience to switch to staging for scraping data. * feat: add docs for dev/staging/prod deploy. --- apiv2/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/apiv2/README.md b/apiv2/README.md index 670a90ead..fc909cb23 100644 --- a/apiv2/README.md +++ b/apiv2/README.md @@ -24,3 +24,14 @@ pre-commit run --all-files # Then commit all changed files, *including* any new migrations! git commit -am "chore: Updating schema to add X feature" ``` + +## Creating an rdev stack +1. Open a pull request +2. Add a label called "stack" to the PR. This will trigger an action that creates an rdev stack. Once the stack has been created, the PR comment will be updated to reflect the URL you can use to access your rdev instance. +3. **NOTE!!:** For now, all rdevs share a database. Fixing this is a TODO. + +## Updating staging/prod +1. Merging a PR to `main` that has a conventional commit title of `feat`, `fix`, or breaking changes (`chore` doesn't count!) will trigger a [release-please](https://github.com/googleapis/release-please/) action that creates a new release candidate PR. +2. Once the release PR has been created, another action gets triggered that builds a new staging docker image. This action also writes updated image sha's to staging/prod envs in `.infra` +3. Once the new image build is complete, *another* action ensures that ArgoCD was able to successfully update staging. +4. Merging the release PR means that the image SHA's in `.infra/prod` are updated in the main branch. ArgoCD will update prod to reflect the latest build.