IF Commons GitHub

sync

verbmutate

Make every generated file, in dependency order, rerunning only the generators whose output is stale.

Program repoctl-releaser. 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.

PropertyValue
kindaction
effectmutate
idempotenttrue
audienceboth
tiercontributor
dryRuntrue
checktrue
reachChannelslocal, mcp
reachReadOnlyfalse
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--onlyOnly these generators, as ids separated by commas (those of the configuration).type=value, required=false, standard=false, humanOnly=false, valueName=ID[,ID]
--jsonWrite one JSON document and nothing else for a person.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--quietShow only how it ended.type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false
--verboseShow every step as it happens.type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false
--colorUse colour where the terminal shows it (--no-color turns it off).type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true
--non-interactiveNever ask a question: where one is needed, fail and say so.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--dry-runShow what would change and change nothing.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--checkChange nothing; end with findings where something would change.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

repoctl sync  # Make every generated file that is stale, in dependency order.
repoctl sync --check  # Write nothing; exit 1 naming each stale generator and the command that fixes it (what CI and the hooks run).
repoctl sync --dry-run  # Say which generators would be run.
repoctl sync --only readme,license  # Only the generators of the README and the licenses.

Physical: what it is drawn as

repoctl sync

cli-command. Make every generated file, in dependency order, rerunning only the generators whose output is stale.

PropertyValue
usagerepoctl sync
wordssync
tiercontributor

repoctl_sync

mcp-tool. Make every generated file, in dependency order, rerunning only the generators whose output is stale. (action, effect mutate, safe to repeat.)

PropertyValue
titlerepoctl sync
toolNamerepoctl_sync
readOnlyHintfalse
destructiveHintfalse
idempotentHinttrue
inputsonly, dryRun, check
tiercontributor

Not drawn

  • rest: its reach policy does not name the rest channel

Titles, headings, exports, tables, columns and requirements. Esc closes.