Skip to content

Commit bbef8d9

Browse files
Add better help description for entrypoint override
1 parent fd496b1 commit bbef8d9

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

cmd/orchestrator/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type initCmd struct {
3939
}
4040

4141
type overrideCmd struct {
42-
Entrypoint []string `help:"Alternative entrypoint to run instead of GOAT. Must bootstrap GOAT."`
42+
Entrypoint []string `help:"Custom init process to execute as PID 1, overriding orchestrator. Must accept and execute the orchestrator command/arguments (e.g., exec \"$@\"), propagate signals, and handle standard init responsibilities like reaping zombie processes."`
4343

4444
runTaskCmd
4545
}

cmd/orchestrator/testdata/override.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@ Usage: test-app [flags]
33
Flags:
44
-h, --help Show context-sensitive help.
55
--entrypoint=ENTRYPOINT,...
6-
Alternative entrypoint to run instead of GOAT. Must bootstrap
7-
GOAT ($CIRCLECI_GOAT_ENTRYPOINT).
6+
Custom init process to execute as PID 1, overriding
7+
orchestrator. Must accept and execute the orchestrator
8+
command/arguments (e.g., exec "$@"), propagate signals,
9+
and handle standard init responsibilities like reaping zombie
10+
processes ($CIRCLECI_GOAT_ENTRYPOINT).
811
--termination-grace-period=10s
912
How long the agent will wait for the task to complete if
1013
interrupted ($CIRCLECI_GOAT_TERMINATION_GRACE_PERIOD).

0 commit comments

Comments
 (0)