Skip to content

Commit d812bdf

Browse files
authored
Merge pull request #120 from deploystackio/feat/disable-provider
feat(docs): add exclude_providers option to deployment configuration
2 parents 69fda92 + 2d630b4 commit d812bdf

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/deploystack/deploystack-config-file.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ You can configure multiple branch deployments using the `deployment.branches` se
6464
| `description` | String | Explain the branch's purpose or version | Maximum 100 characters |
6565
| `active` | Boolean | Whether this branch is available for deployment | Optional, defaults to true |
6666
| `priority` | Number | Order in which branches appear (lower numbers first) | Minimum value: 1 |
67+
| `exclude_providers` | Array | Optional list of cloud providers to exclude from template generation for this branch | Values must be valid provider codes: "aws", "rnd", "dop" |
6768

6869
The default branch always has `priority: 0` and appears first in the deployment options, regardless of other branch priorities.
6970

@@ -80,6 +81,8 @@ deployment:
8081
label: "Beta (v2.x)"
8182
description: "Preview of upcoming v2.x release"
8283
priority: 1
84+
exclude_providers:
85+
- "aws" # Exclude AWS CloudFormation for this branch
8386
v3:
8487
label: "Alpha (v3.x)"
8588
description: "Early preview of v3.x"
@@ -102,6 +105,23 @@ When multiple branches are configured:
102105

103106
This is especially useful for projects that maintain multiple active versions simultaneously, such as stable and beta releases.
104107

108+
The optional `exclude_providers` array allows you to specify which cloud providers should be excluded from template generation for particular branches. This is useful when certain features in a branch version may not be compatible with specific cloud providers. Valid provider codes are:
109+
110+
Please check our [current supported provider list here](/docs/docker-to-iac/parser/index.md).
111+
112+
For example, if your beta version uses features only supported in DigitalOcean, you might exclude the other providers:
113+
114+
```yaml
115+
v2-beta:
116+
label: "Beta"
117+
description: "Beta version with DigitalOcean-specific features"
118+
exclude_providers:
119+
- "aws"
120+
- "rnd"
121+
```
122+
123+
If no providers are excluded, templates will be generated for all supported cloud providers.
124+
105125
## Schema Validation
106126

107127
The configuration file is automatically validated against our JSON Schema when using supported IDEs (VS Code, IntelliJ, etc.). The schema is available at:

0 commit comments

Comments
 (0)