Skip to content

Commit f319a85

Browse files
committed
docs(readme): expand deploy section with workflow overview and add how-it-works breakdown
1 parent 327e229 commit f319a85

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,19 @@ mise lint
3030

3131
## Deploy
3232

33-
There is a [Github Action](https://github.com/ColorCop/colorcop-website/actions/workflows/deploy.yml) that runs when code merges to `master`.
33+
There is a [Github Action](https://github.com/ColorCop/colorcop-website/actions/workflows/deploy.yml) that runs when code merges to `main`. It provisions infrastructure with Terragrunt, builds the site, uploads it to S3, and refreshes CloudFront.
34+
35+
---
36+
37+
## How it works
38+
39+
The deploy workflow automates the full publishing pipeline:
40+
41+
- Triggered by pushes to `main` or `deploy-*`, or manually with a selected branch
42+
- Checks out the branch and configures temporary AWS credentials
43+
- Runs Terragrunt `init`, `plan`, and `apply` to update CloudFront, S3, and related infrastructure
44+
- Reads Terragrunt outputs (S3 bucket name and CloudFront distribution ID)
45+
- Builds the Jekyll site using Bundler and `mise build`
46+
- Validates the CloudFront distribution and S3 bucket
47+
- Syncs the built `_site/` directory to the S3 bucket
48+
- Invalidates CloudFront so new content is served immediately

0 commit comments

Comments
 (0)