Skip to content

Commit d2ad497

Browse files
committed
Update environment documentation; correct YAML title and remove redundant examples for clarity
1 parent dab6ce5 commit d2ad497

1 file changed

Lines changed: 2 additions & 27 deletions

File tree

docs/examples/environments.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A platform has two services. Each service needs different variables per environm
1414

1515
Profile-level environments define shared variables and tasks that apply across all repos. Repo-specific variables and tasks are defined in each repo's own `raid.yaml`.
1616

17-
```yaml title="platform-profile.yaml"
17+
```yaml title="platform.raid.yaml"
1818
name: platform
1919

2020
repositories:
@@ -124,32 +124,7 @@ raid env
124124
raid env list
125125
```
126126

127-
### What `raid env staging` does
128-
129-
```
130-
Applying environment 'staging'...
131-
Switched to staging
132-
133-
Running repo environment tasks...
134-
✓ api applied 4 variables
135-
✓ frontend applied 2 variables
136-
137-
Done.
138-
```
139-
140-
For production, the `Confirm` tasks gate the switch:
141-
142-
```
143-
Applying environment 'production'...
144-
? Switch ALL services to production? (y/N) y
145-
146-
Running repo environment tasks...
147-
? Point API at production database? (y/N) y
148-
[api] rotate-api-key.sh
149-
? Point frontend at production APIs? (y/N) y
150-
151-
Done.
152-
```
127+
For production, the `Confirm` tasks in the profile and each repo's `raid.yaml` will gate the switch before any variables or tasks are applied.
153128

154129
## Dynamic local environments
155130

0 commit comments

Comments
 (0)