enabled
The enabled configuration allows you to enable or disable a repository. When a repository is disabled, Terrateam will ignore all events from that repository, effectively turning off Terrateam for that specific repository.
Default Configuration
Section titled “Default Configuration”enabled: true| Key | Type | Description |
|---|---|---|
| enabled | Boolean | Specifies whether Terrateam is enabled or disabled in this repository. Default is true. |
Examples
Section titled “Examples”Enabling a Repository
Section titled “Enabling a Repository”enabled: trueThis configuration will enable Terrateam for the repository, allowing it to process events and perform Terraform operations as configured.
Disabling a Repository
Section titled “Disabling a Repository”enabled: falseThis configuration will disable Terrateam for the repository, causing it to ignore all events and effectively turning off Terrateam for the repository.
Considerations
Section titled “Considerations”When setting the enabled status for a repository, keep the following in mind:
- Disabling a repository can be useful when you need to temporarily stop Terrateam from processing events and performing Terraform operations, such as during maintenance or troubleshooting.
- When a repository is disabled, Terrateam will not process any events, including pull request creation, updates, and merges. This means that no plans or applies will be performed, and no comments will be added to pull requests.
- Disabling a repository does not affect any existing Terraform state or resources that have been provisioned by Terrateam. It simply prevents Terrateam from making any further changes to the infrastructure.