doc: update ci doc

ymgyt · Sep 16, 2024 · 0fd8ac8 · 0fd8ac8
1 parent 7e5be0f
commit 0fd8ac8
Showing 1 changed file with 24 additions and 7 deletions.
diff --git a/docs/ci.md b/docs/ci.md
@@ -4,13 +4,15 @@
 
 ### Workflows
 
-| Workflow        | Trigger   | Role                         |
-| ---             | ---       | ---                          |
-| `audit`         | Schedule  | Audit security               |
-| `ci`            | Push, PR  | Test, Lint, Coverage         |
-| `release`       | TagPush   | Distribution, GitHub Release |
-| `release_image` | TagPush   | PushDockerImage              |
-| `website`       | Push, PR  | Update website               |
+| Workflow          | Trigger  | Role                         |
+|-------------------|----------|------------------------------|
+| `audit`           | Schedule | Audit security               |
+| `ci`              | Push, PR | Test, Lint, Coverage         |
+| `release`         | TagPush  | Distribution, GitHub Release |
+| `release_image`   | TagPush  | PushDockerImage              |
+| `terraform_apply` | PR       | Run terraform apply          |
+| `terraform_plan`  | Push     | Run terraform paln           |
+| `website`         | Push, PR | Update website               |
 
 
 #### [`audit`](https://github.com/ymgyt/syndicationd/blob/main/.github/workflows/audit.yaml)  
@@ -31,6 +33,21 @@ Whether a package is included in this workflow is controlled by the `[package.me
 
 Build the package's docker image and push it to the registry
 
+### [`terraform_apply`](https://github.com/ymgyt/syndicationd/blob/main/.github/workflows/terraform_apply.yaml)
+
+This workflow is triggered when a PR is marged into the main branch.  
+It runs `terraform apply` and posts the result as a comment on the PR.  
+The terraform state is stored on Hashicorp Cloud.
+
+
+
+### [`terraform_plan`](https://github.com/ymgyt/syndicationd/blob/main/.github/workflows/terraform_plan.yaml)
+
+This workflow will be griggered when terraform-related files are modified.  
+It runs `terraform plan` and posts the result as a comment on the PR.  
+The terraform state is stored on Hashicorp Cloud.
+
+
 #### [`website`](https://github.com/ymgyt/syndicationd/blob/main/.github/workflows/website.yaml)
 
 The workflow generated by `oranda generate ci` uploads the project's website to GitHub Pages.