Skip to content

DEV-2495: Update FAQ for GitOps Labels #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dan Miller (milldr) merged 1 commit into from
Apr 18, 2025
Merged

DEV-2495: Update FAQ for GitOps Labels #744

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions docs/layers/gitops/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,21 @@ sidebar_position: 10

### What are the included labels?

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.

On Pull Requests:
By default, Cloud Posse includes a few labels for common use-cases.

#### Pull Request Labels
1. `auto-apply` - If added, the Atmos Terraform Apply workflow will be triggered for all affected components when the Pull Request is merged.
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.

On Issues:

1. `apply` - If added, the Atmos Terraform Drift Remediation workflow will be triggered for the given component and stack
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.
1. `remediated` - This label is added to any Issue that has been resolved by Atmos Terraform Drift Remediation
#### Issue Labels
- `apply` - Triggers the Atmos Terraform Drift Remediation workflow for a specific component and stack
- `discarded` - Issue was closed by the drift detection workflow
- `drift` - Indicates that drift was detected by the drift detection workflow
- `drift-recovered` - Indicates that an issue is no longer experiencing drift
- `error` - Indicates an error occurred during planning for a specific component and stack
- `error-recovered` - Indicates that an error state has been resolved
- `remediated` - Issue was successfully remediated by the drift remediation action
- `removed` - Issue is closed because the component no longer exists (code was deleted)

### Enabling or disabling components

Expand Down
Loading