Skip to content

Commit 0fc233b

Browse files
authored
Update README.md
1 parent 1b25ced commit 0fc233b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,25 @@
22

33
A git repository that I use to try terraform.
44

5+
56
## Terraform Workflow Status
67

78
[![Terraform](https://github.com/moazrai/terraform-basics/actions/workflows/terraform.yaml/badge.svg?branch=main&event=push)](https://github.com/moazrai/terraform-basics/actions/workflows/terraform.yaml)
89

10+
### Release Runbook
11+
1. Add a commit on a new branch with the changes
12+
2. Create a pull request into the main branch. This will trigger a workflow to:
13+
1. Validate syntax of Terraform code (will catch the missing double-quote that happened before)
14+
2. Check correct code formatting
15+
3. Run the plan command and add a comment to the PR with the output plan changes
16+
4. Run a static code analysis tool for scanning IaC files for misconfigurations that may lead to security or compliance problems (such as Checkov, tfsec or Snyk)
17+
3. Reviewer reviews code changes from the PR (if all checks have passed) and also review plan changes from the PR as well
18+
4. If the plan is okay, merge PR into main. This will trigger a workflow to run terraform apply to apply the plan
19+
20+
### Notes:
21+
- We can trigger the apply workflow on creating a release instead of merging to main
22+
- Branch protection rule on main branch is added to not allow merging into main without having all the checks passed
23+
924
## Configuring the Remote Backend to use Azure Storage with Terraform
1025

1126
Use Microsoft Azure Storage to create a Remote Backend for Terraform to store the state file and lock the file to avoid mistakes or damage the existing infrastructure.

0 commit comments

Comments
 (0)