impl-tool followup rule
Record a ruling on one local item, by scope and id
- Command version
0.0.0- Command configuration
impl-tool:impl-tool.followup.rule@0.0.0
Arguments
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--path | path | No | "." | Directory to act on (default: current directory) |
--branch | string | No | Branch whose local state is changed, taken literally. Defaults to the branch the issue is worked on, then to the branch the target directory is on | |
--issue | string | No | Issue whose branch to change. Defaults to the issue the target directory is about -- its branch, its workspace name, or the observer it records | |
--scope | string | Yes | The repository the item belongs to -- '.' for the superproject, the submodule path otherwise | |
--id | list[integer] | Yes | The item's local id, from 'followup sync' or 'followup list' -- space-separated for more than one, to record the same ruling on several items at onceRepeatable | |
--state | followUpRuling one of accepted, rejected, resolved | Yes | The ruling: 'accepted', 'rejected' or 'resolved' -- 'open' is not a ruling, and 'followup reset' is what puts an item back to it | |
--evidence | string | No | "" | What the state points at -- whatever now tracks an accepted item, the commit for a resolved one, and nothing for a rejected one, whose reason is --rationale. Name the thing alone, since it is rendered beneath the item under the state's own label |
--rationale | string | No | "" | Why the ruling was made, read by whoever decides whether it still holds. Required of a rejection, welcome on any other ruling, and rendered as the indented 'Why:' line beneath the item |
It also takes the global arguments.
Output
It answers with a followUpMutationSummary.
Examples
impl-tool followup rule --scope . --id 2 --state accepted --evidence 'the `retry-upload-budget` note'Accept an item, naming by slug the queue note that now carries it.
impl-tool followup rule --scope . --id 3 --state resolved --evidence 'done in `3f2a9c1`'Mark an item resolved, naming the commit that closed it.
impl-tool followup rule --scope services/api --id 1 2 --state rejected --rationale 'The key is read by a client we do not control'Reject two items at once, saying why they will not be done.
Errors
| Code | Meaning | Remedy |
|---|---|---|
TARGET_PATH_NOT_DIRECTORY | The path --path names is not a directory. | Pass --path naming the checkout to act on, or leave it out to act on the current directory. |
FOLLOWUP_EVIDENCE_UNUSABLE | The evidence or the rationale given does not suit the ruling -- an accepted item names its queue note, a resolved one its commit, a rejected one says why; each problem is its own error. | Give --evidence and --rationale as the messages say the state needs them. |
BRANCH_NOT_CHECKED_OUT | No checkout is on the issue's branch, or which one holds it could not be told, so there is no working tree to read the branch's submodules from. | Check the branch out, run the command from the workspace that holds it, or name the branch with --branch where the work is not on the issue's branch. |
FOLLOWUP_ITEM_NOT_FOUND | The follow-up item named is not in the scope's local section, or --id was given without exactly one --scope, which an id needs since it is unique only within one. | Run followup list to see the items and their ids, and name the item with one --scope and its --id. |
Also every code of cli:cli
| Code | Meaning | Remedy |
|---|---|---|
REPO_ROOT_VALIDATION_FAILED | The repository root the run was given, by --repo-root or by the directory it was started in, is not a directory that can be acted on. | Run the command from inside the repository, or pass --repo-root naming its root. |
RUNTIME_CONFIG_FAILED | A runtime configuration file the run reads -- the application's cli.config.yml at one of its scopes -- does not load, or sets an argument default a scope may not set. | Correct the file the message names; config init writes one that loads. |
COMMAND_CONFIG_FAILED | The configuration the command itself is declared by does not load, so the command cannot be run. This is a fault in the application as it was built, not in anything the person running it supplied. | Report it against the application's release, with the message; reinstalling the release with update --force replaces a damaged copy. |
MANIFEST_VALIDATION_FAILED | The command reads the repository's manifest.yml, and none was found at the root, or the one found does not load. | Run the command in a repository that has a manifest, pass --manifest naming one, or correct the manifest where the message says it does not load. |
APP_CONFIG_FAILED | The application's own configuration file in the repository does not load against the type the application declares for it. | Correct the file the message names; config init writes one that loads. |
INPUT_VALIDATION_FAILED | An argument the command line gave is not one the command accepts once it is read -- the wrong type, a value outside its choices, or one a rule on the input refuses. | Give the argument as the command's --help describes it. |
OUTPUT_VALIDATION_FAILED | The command answered with data that does not match the output it declares, so the answer was withheld. This is a fault in the command, not in how it was run. | Report it against the application's release, with the command line that produced it. |
PIPE_STDIN_NOT_PIPED | The command was asked to take its input from stdin, by --from-stdin or by - as a document input's value, and nothing is piped to it -- stdin is a terminal, or there is none. | Pipe in the output of a command run with --response-format json, or give the input another value. |
SECRET_NOT_GIVEN | The command takes a secret input, which is never typed on the command line, and nothing was typed at its prompt or piped to its standard input. | Run the command at a terminal and type the value at the prompt, or pipe it to the command's standard input, one line for each secret it takes. |
SECRET_STDIN_CLAIMED | The command takes a secret input from standard input, and standard input already carries its piped inputs -- --from-stdin, or a document input given - -- so there is nothing to read the secret from. | Run the command at a terminal to be asked for the secret, or give its other inputs on the command line. |
PIPE_STDIN_CLAIMED_TWICE | --from-stdin was given beside a document input given - or -:<path>, so the piped answer would be both the command's inputs and one of them. | Keep one of the two forms. |
PIPE_FIELD_NOT_FOUND | A document input given -:<path> names a field the piped answer does not hold -- a key no mapping on the way has, or an index past the end of a list or into something that is no list -- or the text after -: is no path. | Name a field the command before the pipe answers with, as keys joined by . with [<n>] picking an item from a list, as releases[0].notes. |
ENVELOPE_UNREADABLE | What was piped to the command is not an envelope a command writes, so there is no answer in it to take as input. | Run the command before the pipe with --response-format json, and pipe nothing else between the two. |
PIPE_UPSTREAM_FAILED | The command before the pipe refused, so there is no answer to take as input and this command did not run. Its own errors follow this one in the envelope. | Repair what the errors after this one name, in the command before the pipe, and run the pipeline again. |
PIPE_ANSWER_NOT_INPUTS | --from-stdin takes the piped answer as the command's inputs by name, and the answer is no mapping, or carries a field the command declares no input for. | Pipe in a command whose answer holds only this command's inputs, or give the answer to one document input with - instead. |
UNHANDLED_EXCEPTION | The command failed in a way nothing anticipated, and the message is the failure's own text. | Report it against the application's release, with the command line and the message. |
APPLICATION_RELEASE_NAME_UNKNOWN | The application could not tell which release it is -- the project it was released with, or which of that project's applications it is -- so it cannot look its releases up. | Run the application as it was installed, from the directory toolchain install placed it in, or report it against the release. |
Exit codes
| Code | Meaning |
|---|---|
0 | The command answered; the envelope's status is success and errors is empty. |
1 | The command or the framework refused; the envelope's status is error and errors names each code, with its message. |
2 | The command line could not be read -- an unknown command, a missing or unknown argument -- so nothing ran and no envelope was written; the usage is printed instead. |