Skip to content

Commit 38ea4ef

Browse files
LauJosefsenclaude
andcommitted
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>
1 parent 0ce62f9 commit 38ea4ef

5 files changed

Lines changed: 46 additions & 46 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,21 @@ projects:
8383
remote: git@github.com:example/myservice.git
8484
default_branch: main
8585
actions:
86-
up:
86+
start:
8787
groups:
8888
local: ["docker", "compose", "up", "-d"]
89-
down:
89+
stop:
9090
groups:
9191
local: ["docker", "compose", "down"]
9292
```
9393
9494
**2.** Run the full pipeline:
9595
9696
```bash
97-
gitte run up local
97+
gitte run start local
9898
```
9999

100-
Gitte will run startup checks, pull all repos, then execute the `up` action for group `local` across all enabled projects.
100+
Gitte will run startup checks, pull all repos, then execute the `start` action for group `local` across all enabled projects.
101101

102102
---
103103

@@ -124,11 +124,11 @@ Gitte will run startup checks, pull all repos, then execute the `up` action for
124124
Arguments to `run` and `actions` are positional: `action [group] [projects]`.
125125

126126
```bash
127-
gitte run up # up action, all groups, all enabled projects
128-
gitte run up local # up action, group local, all enabled projects
129-
gitte run up local myservice # up action, group local, project myservice only
130-
gitte run up local frontend+backend # up action, group local, projects frontend and backend
131-
gitte run up+build # run up then build, all groups, all enabled projects
127+
gitte run start # start action, all groups, all enabled projects
128+
gitte run start local # start action, group local, all enabled projects
129+
gitte run start local myservice # start action, group local, project myservice only
130+
gitte run start local frontend+backend # start action, group local, projects frontend and backend
131+
gitte run start+test # run start then test, all groups, all enabled projects
132132
```
133133

134134
Use `*` or `all` as a wildcard. Combine multiple values with `+`.

cmd/actions.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ func newActionsCmd() *cobra.Command {
1515
Long: `Run actions only on configured projects.
1616
1717
Examples:
18-
gitte actions up
19-
gitte actions up sn
20-
gitte actions up+build sn
21-
gitte actions up sn evolution+promotion`,
18+
gitte actions start
19+
gitte actions start local
20+
gitte actions start+test local
21+
gitte actions start local frontend+backend`,
2222
Args: cobra.RangeArgs(1, 3),
2323
ValidArgsFunction: actionArgsCompletion,
2424
RunE: func(cmd *cobra.Command, args []string) error {

cmd/run.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ func newRunCmd() *cobra.Command {
2020
Long: `Run the full pipeline: startup checks, git sync, then actions.
2121
2222
Examples:
23-
gitte run up
24-
gitte run up sn
25-
gitte run up+build sn
26-
gitte run up sn evolution+promotion`,
23+
gitte run start
24+
gitte run start local
25+
gitte run start+test local
26+
gitte run start local frontend+backend`,
2727
Args: cobra.RangeArgs(0, 3),
2828
ValidArgsFunction: actionArgsCompletion,
2929
RunE: func(cmd *cobra.Command, args []string) error {

docs/commands.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ All commands support the global flags `--config <path>`, `--cwd <path>`, and `--
99
Full pipeline: startup checks → git sync → actions.
1010

1111
```bash
12-
gitte run up
13-
gitte run up local
14-
gitte run up local myservice
15-
gitte run up local frontend+backend
16-
gitte run up+build
17-
gitte run up --discover # also fetch repos from configured sources first
12+
gitte run start
13+
gitte run start local
14+
gitte run start local myservice
15+
gitte run start local frontend+backend
16+
gitte run start+test
17+
gitte run start --discover # also fetch repos from configured sources first
1818
```
1919

2020
Arguments:
@@ -29,9 +29,9 @@ Arguments:
2929
Run actions only, skipping startup checks and git sync. Same argument syntax as `run`.
3030

3131
```bash
32-
gitte actions up
33-
gitte actions up local
34-
gitte actions down local myservice
32+
gitte actions start
33+
gitte actions start local
34+
gitte actions stop local myservice
3535
```
3636

3737
---

docs/config.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -115,22 +115,22 @@ projects:
115115
vars: # template variable overrides (optional)
116116
stack_name: myservice-custom
117117
actions:
118-
up:
119-
needs: [database] # run after database:up completes
118+
start:
119+
needs: [database] # run after database:start completes
120120
retry:
121121
attempts: 2
122122
delay: 10s
123123
backoff: exponential
124124
groups:
125125
prod: ["docker", "stack", "deploy", "myservice-prod"]
126126
staging: ["docker", "compose", "up", "-d"]
127-
down:
127+
stop:
128128
groups:
129129
prod: ["docker", "stack", "rm", "myservice-prod"]
130130
staging: ["docker", "compose", "down"]
131-
build:
131+
test:
132132
groups:
133-
"*": ["make", "build"] # wildcard group matches any group argument
133+
"*": ["make", "test"] # wildcard group matches any group argument
134134
```
135135

136136
### Remote URL formats
@@ -145,7 +145,7 @@ https://github.com/example/myservice.git → github.com/example/myservice
145145

146146
### actions
147147

148-
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.
149149

150150
**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.
151151

@@ -173,11 +173,11 @@ templates:
173173
vars:
174174
stack: "{{.project}}-prod"
175175
actions:
176-
up:
176+
start:
177177
groups:
178178
prod: ["docker", "stack", "deploy", "{{.stack}}"]
179179
staging: ["docker", "compose", "up", "-d"]
180-
down:
180+
stop:
181181
groups:
182182
prod: ["docker", "stack", "rm", "{{.stack}}"]
183183
staging: ["docker", "compose", "down"]
@@ -195,7 +195,7 @@ projects:
195195
vars:
196196
stack: "backend-custom-prod" # override specific variable
197197
actions:
198-
up:
198+
start:
199199
needs: [database] # add dependency on top of template
200200
```
201201

@@ -211,14 +211,14 @@ templates:
211211
vars:
212212
stack: "{{.project}}"
213213
actions:
214-
down:
214+
stop:
215215
groups:
216216
prod: ["docker", "stack", "rm", "{{.stack}}"]
217217
218218
php-service:
219219
extends: [base-service] # inherits all of base-service
220220
actions:
221-
up:
221+
start:
222222
needs: [database]
223223
224224
full-service:
@@ -235,12 +235,12 @@ Multiple parents are merged left-to-right; the rightmost definition wins for con
235235

236236
```yaml
237237
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"
241241
```
242242

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.
244244

245245
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.
246246

@@ -266,7 +266,7 @@ retry:
266266
projects:
267267
myservice:
268268
actions:
269-
up:
269+
start:
270270
retry:
271271
attempts: 3
272272
delay: 10s
@@ -292,8 +292,8 @@ Override per-action settings globally.
292292

293293
```yaml
294294
actionOverride:
295-
down:
296-
maxParallelization: 1 # run down actions one at a time
295+
stop:
296+
maxParallelization: 1 # run stop actions one at a time
297297
```
298298

299299
---
@@ -316,7 +316,7 @@ Can also be defined per-action:
316316
projects:
317317
myservice:
318318
actions:
319-
up:
319+
start:
320320
searchFor:
321321
- regex: "port already in use"
322322
hint: "Port conflict — check for other running services"
@@ -401,7 +401,7 @@ Run discovery with:
401401

402402
```bash
403403
gitte gitops --discover
404-
gitte run up --discover # discover, then sync, then run actions
404+
gitte run start --discover # discover, then sync, then run actions
405405
```
406406

407407
---

0 commit comments

Comments
 (0)