IF Commons GitHub

docs build

verbmutate

Build the documentation site of this repository with the documentation generator, into the folder its configuration names.

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
checkfalse
reachChannelslocal, mcp
reachReadOnlyfalse
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--outThe folder to build into (the configuration's docs.out by default).type=value, required=false, standard=false, humanOnly=false, valueName=DIR
--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

Examples

repoctl docs build  # Build the site into the folder the configuration names.
repoctl docs build --dry-run  # Say what the generator would be asked, and build nothing.

Physical: what it is drawn as

repoctl docs build

cli-command. Build the documentation site of this repository with the documentation generator, into the folder its configuration names.

PropertyValue
usagerepoctl docs build
wordsdocs, build
tiercontributor

repoctl_docs_build

mcp-tool. Build the documentation site of this repository with the documentation generator, into the folder its configuration names. (action, effect mutate, safe to repeat.)

PropertyValue
titlerepoctl docs build
toolNamerepoctl_docs_build
readOnlyHintfalse
destructiveHintfalse
idempotentHinttrue
inputsout, dryRun
tiercontributor

Not drawn

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

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