ci step
verbmutateRun one step of a pipeline under the build policy: run the command given after --, keep what it prints, read it into findings with the parser of its tool, write the step's findings file and end 0 whatever the command's status was (commons 0038-build-policy FR-013).
Program repoctl-contributor. Origin repoctl.
Governance: the action
What the verb is and may do, as governance says it. Each annotation is expressed by the surfaces or says why it is not.
| Property | Value |
|---|---|
kind | action |
effect | mutate |
idempotent | false |
audience | both |
tier | contributor |
dryRun | false |
check | false |
reachChannels | local |
reachReadOnly | false |
reachNeedsTty | false |
reachRunsAs | caller |
reachConfirmation | none |
Options
| Option | Meaning | Properties |
|---|---|---|
--id | The step's id: letters, digits, dots, hyphens and underscores. | type=value, required=true, standard=false, humanOnly=false, valueName=ID |
--job | The job the step is in. | type=value, required=false, standard=false, humanOnly=false, valueName=JOB, default=local |
--module | The module (library) its findings are of. | type=value, required=false, standard=false, humanOnly=false, valueName=NAME, default=repository |
--tool | The tool whose output is read: tsc, bun-test, lint, format, repoctl-check, mizan-check, kanon-check, generated-files, verify, checks, exit-status, install. | type=value, required=false, standard=false, humanOnly=false, valueName=TOOL, default=exit-status |
--timeout | The minutes after which the command is stopped. | type=value, required=false, standard=false, humanOnly=false, valueName=MINUTES, default=15 |
--out | The folder the step's findings file is written to. | type=value, required=false, standard=false, humanOnly=false, valueName=DIR, default=_findings |
--json | Write one JSON document and nothing else for a person. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--quiet | Show only how it ended. | type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--verbose | Show every step as it happens. | type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--color | Use colour where the terminal shows it (--no-color turns it off). | type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true |
--non-interactive | Never ask a question: where one is needed, fail and say so. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
Examples
repoctl ci step --id tests --tool bun-test -- bun test # Run the tests and keep the failing ones as findings.Physical: what it is drawn as
repoctl ci step
cli-command. Run one step of a pipeline under the build policy: run the command given after --, keep what it prints, read it into findings with the parser of its tool, write the step's findings file and end 0 whatever the command's status was (commons 0038-build-policy FR-013).
| Property | Value |
|---|---|
usage | repoctl ci step |
words | ci, step |
tier | contributor |
Not drawn
- mcp: its reach policy does not name the mcp channel
- rest: its reach policy does not name the rest channel