Skip to content

README.md

Latest commit

 

History

History
48 lines (32 loc) · 1.62 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.62 KB

colorcop-website

GitHub Actions Status License: MIT

A static website for the ColorCop project, built with Jekyll and managed using mise for consistent tooling and reproducible development environments.

Installation

This project uses mise to configure the development environment.

  • Install mise
  • Run mise trust and answer yes.
  • Run mise install to install the required tools
  • Run bundle install

Running locally

mise serve

Running linters

mise lint

Deploy

There is a Github Action that runs when code merges to main. It provisions infrastructure with Terragrunt, builds the site, uploads it to S3, and refreshes CloudFront.

How it works

The deploy workflow automates the full publishing pipeline:

  • Triggered by pushes to main or deploy-*, or manually with a selected branch
  • Checks out the branch and configures temporary AWS credentials
  • Runs Terragrunt init, plan, and apply to update CloudFront, S3, and related infrastructure
  • Reads Terragrunt outputs (S3 bucket name and CloudFront distribution ID)
  • Builds the Jekyll site using Bundler and mise build
  • Validates the CloudFront distribution and S3 bucket
  • Syncs the built _site/ directory to the S3 bucket
  • Invalidates CloudFront so new content is served immediately