You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: use consistent start/stop/test example actions in help and docs
Align the example action names (start, stop, test) and group names
(local, team-a, team-b, shared, infra) across the CLI help text,
README, and documentation so all examples follow one coherent scheme.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Each action maps group names to commands. When you run `gitte run up prod`, gitte executes the command under `groups.prod` for each enabled project that has an `up` action.
148
+
Each action maps group names to commands. When you run `gitte run start prod`, gitte executes the command under `groups.prod` for each enabled project that has a `start` action.
149
149
150
150
**needs** — list of project names that must complete this action successfully before this project starts. Gitte resolves the full dependency graph and runs independent tasks in parallel.
151
151
@@ -173,11 +173,11 @@ templates:
173
173
vars:
174
174
stack: "{{.project}}-prod"
175
175
actions:
176
-
up:
176
+
start:
177
177
groups:
178
178
prod: ["docker", "stack", "deploy", "{{.stack}}"]
179
179
staging: ["docker", "compose", "up", "-d"]
180
-
down:
180
+
stop:
181
181
groups:
182
182
prod: ["docker", "stack", "rm", "{{.stack}}"]
183
183
staging: ["docker", "compose", "down"]
@@ -195,7 +195,7 @@ projects:
195
195
vars:
196
196
stack: "backend-custom-prod" # override specific variable
197
197
actions:
198
-
up:
198
+
start:
199
199
needs: [database] # add dependency on top of template
200
200
```
201
201
@@ -211,14 +211,14 @@ templates:
211
211
vars:
212
212
stack: "{{.project}}"
213
213
actions:
214
-
down:
214
+
stop:
215
215
groups:
216
216
prod: ["docker", "stack", "rm", "{{.stack}}"]
217
217
218
218
php-service:
219
219
extends: [base-service] # inherits all of base-service
220
220
actions:
221
-
up:
221
+
start:
222
222
needs: [database]
223
223
224
224
full-service:
@@ -235,12 +235,12 @@ Multiple parents are merged left-to-right; the rightmost definition wins for con
235
235
236
236
```yaml
237
237
groupIncludes:
238
-
sn: [cego] # running group "sn" also runs group "cego"
239
-
ht: [cego] # running group "ht" also runs group "cego"
240
-
cego: [streaming] # transitive: "sn" and "ht" also pull in "streaming"
238
+
team-a: [shared] # running group "team-a" also runs group "shared"
239
+
team-b: [shared] # running group "team-b" also runs group "shared"
240
+
shared: [infra] # transitive: "team-a" and "team-b" also pull in "infra"
241
241
```
242
242
243
-
Expansion is **transitive** — if `sn` includes `cego` and `cego` includes `streaming`, then running group `sn` automatically includes both `cego` and `streaming` tasks.
243
+
Expansion is **transitive** — if `team-a` includes `shared` and `shared` includes `infra`, then running group `team-a` automatically includes both `shared` and `infra` tasks.
244
244
245
245
This replaces the need for `*` wildcard groups on infrastructure projects. Give an infrastructure project a specific group name and list it in `groupIncludes` for the teams that need it.
0 commit comments