Skip to content

Commit dc75273

Browse files
authored
DEV-2495: Update FAQ for GitOps Labels (#744)
1 parent 4bc2e7f commit dc75273

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

docs/layers/gitops/faq.mdx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,21 @@ sidebar_position: 10
66

77
### What are the included labels?
88

9-
By default, Cloud Posse includes a few labels for common use-cases. These labels are included with the top level workflows, so they can be modified as desired.
10-
11-
On Pull Requests:
9+
By default, Cloud Posse includes a few labels for common use-cases.
1210

11+
#### Pull Request Labels
1312
1. `auto-apply` - If added, the Atmos Terraform Apply workflow will be triggered for all affected components when the Pull Request is merged.
1413
1. `no-plan` - If added, the Atmos Terraform Plan workflow will be skipped on commits to the Pull Request, and the Atmos Apply workflow will be skipped when the Pull Request is merged.
1514

16-
On Issues:
17-
18-
1. `apply` - If added, the Atmos Terraform Drift Remediation workflow will be triggered for the given component and stack
19-
1. `drift` - This label is added to all Issues created by Atmos Terraform Drift Detection. Remediation will only run on Issues that have this label.
20-
1. `remediated` - This label is added to any Issue that has been resolved by Atmos Terraform Drift Remediation
15+
#### Issue Labels
16+
- `apply` - Triggers the Atmos Terraform Drift Remediation workflow for a specific component and stack
17+
- `discarded` - Issue was closed by the drift detection workflow
18+
- `drift` - Indicates that drift was detected by the drift detection workflow
19+
- `drift-recovered` - Indicates that an issue is no longer experiencing drift
20+
- `error` - Indicates an error occurred during planning for a specific component and stack
21+
- `error-recovered` - Indicates that an error state has been resolved
22+
- `remediated` - Issue was successfully remediated by the drift remediation action
23+
- `removed` - Issue is closed because the component no longer exists (code was deleted)
2124

2225
### Enabling or disabling components
2326

0 commit comments

Comments
 (0)