Skip to content

Commit 12c5bb1

Browse files
committed
Updates to workflow description
1 parent e3289e7 commit 12c5bb1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,15 @@ Each environment is essentially a bunch of different services all governed by `d
200200

201201
### Basic workflow
202202

203-
- A PR merged to either `development` or `master` will trigger CI to build container images that are then tagged (based on the branch name and ":latest" respectively) and stored in our GitHub Packages container image repository.
203+
- A PR merged to either `development`, `staging`, or `main` will trigger CI to build container images that are then tagged with the branch name (or ":latest", in the cast of `main`), and stored in our GitHub Packages container image repository.
204204
- CI triggers a webhook that tells the host systems to pull and run new container images and restart any services that have been updated.
205205

206+
As a developer, your path to getting changes into production should be something like this:
207+
208+
- Source your working branch from `development`, do work, PR and merge when complete
209+
- PR and merge to `staging` in order to get your changes deployed to https://staging.delphi.cmu.edu/signals for review
210+
- PR and merge to `main` to go to production
211+
206212
**IMPORTANT!** - The CI/CD process uses Docker Compose to build the specific container images that will be used in external environments. Success of the the build-and-deploy workflow is dependent on constructed services in `docker-compose.yaml`. If considering making changes there, please have a PR reviewed by devops folks :pray: :pray: :pray:
207213

208214
### Control of the deployed environment

0 commit comments

Comments
 (0)