Intro to CI/CD 💻 ☁️

TLDR; This repository is a sample project demonstrating a basic continuous integration (CI) / continuous deployment (CD) setup. This project is in READ ONLY mode.

Project structure

# You can generate this tree with:
# $ tree -a -I '.git|assets|.github|venv|node_modules|images|.DS_Store|*.tfvars|.terraform'
.
├── .gitignore
├── CODEOWNERS
├── LICENSE
├── README.md
├── infra
│   ├── README.md
│   └── instances
│       ├── production
│       │   ├── .terraform.lock.hcl
│       │   ├── main.tf
│       │   └── terraform.auto.tfvars.example
│       └── staging
│           ├── .terraform.lock.hcl
│           ├── create_staging_resource.sh
│           ├── extra_staging.tf.example
│           ├── main.tf
│           └── terraform.tfvars.auto.example
└── web
    ├── README.md
    ├── app.js
    ├── bin
    │   └── www
    ├── package-lock.json
    ├── package.json
    ├── public
    │   ├── javascripts
    │   └── stylesheets
    │       └── style.css
    ├── routes
    │   ├── index.js
    │   └── users.js
    ├── tests
    │   ├── app.test.js
    │   └── routes.test.js
    └── views
        ├── error.jade
        ├── index.jade
        └── layout.jade

12 directories, 26 files

• infra/images: contains Packer template to build our AWS EC2 AMI
• infra/instances: contains our Terraform templates to setup our staging and production EC2 instances
• web: contains our simple Express web application

Setup

Configure your GitHub repository to run the workflows

Click to expand

1. Navigate to the Settings in your repository then to Environments

2. Add a new environment and call it staging (or anything else you like)

3. Enable required reviewers and add your secrets

4. Enable branch protection on the main branch

Test your setup

1. Create a new branch from the main branch and make some changes to the app
2. Push the new branch to GitHub
3. Watch the CI workflow being triggered
4. Troubleshoot issues as they rise