impl-tool session end

Close out the branch the session worked, and stamp the session closed

Command version
0.0.0
Command configuration
impl-tool:impl-tool.session.end@0.0.0

Arguments

ArgumentTypeRequiredDefaultDescription
--create-pull-request,
--no-create-pull-request
booleanNofalseOpen pull requests where none exist yet, for the branch and its modified submodules, while generating the branch's history
--pathpathNo"."Directory to act on (default: current directory)

It also takes the global arguments.

Output

It answers with a end.sessionEndSummary.

Examples

impl-tool session end

Close out the session's branch -- push it, describe its pull requests -- and stamp the session closed.

impl-tool session end --create-pull-request

Do the same, opening the pull requests the branch does not have yet.

Errors

CodeMeaningRemedy
TARGET_PATH_NOT_DIRECTORYThe 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.
SESSION_AMBIGUOUSMore than one workspace holds an open session, so which to end cannot be told.Pass --path naming the workspace whose session to end.
SESSION_CLOSE_OUT_FAILEDClosing the session out -- committing what it left, shipping and describing the increment -- failed; the message names the step.Repair what the message names and run session end in the workspace to close it out again.
Also every code of cli:cli
CodeMeaningRemedy
REPO_ROOT_VALIDATION_FAILEDThe 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_FAILEDA 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_FAILEDThe 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_FAILEDThe 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_FAILEDThe 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_FAILEDAn 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_FAILEDThe 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_PIPEDThe 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_GIVENThe 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_CLAIMEDThe 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_FOUNDA 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_UNREADABLEWhat 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_FAILEDThe 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_EXCEPTIONThe 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_UNKNOWNThe 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

CodeMeaning
0The command answered; the envelope's status is success and errors is empty.
1The command or the framework refused; the envelope's status is error and errors names each code, with its message.
2The 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.

Types

end.sessionEndSummary

FieldTypeRequiredDefaultDescription
issuestringYesThe id of the issue the ended session was working. Empty where no session was open
incrementintegerYesThe increment number the branch stands at: the highest any commit on it carries, counted from zero, and -1 where none carries one
incrementsintegerYesHow many increments this session made: how far the branch's numbering has moved since the session opened
endedbooleanYesTrue where the session was stamped closed. False where none was open, and where the close-out failed, which leaves the session open to be ended again
durationSecondsnumberYesSeconds the session was open, from when it started to this close, rounded to a tenth
pullRequeststringYesURL of the pull request for the branch the session worked. Empty where there is none
treelist[string]YesThe repository and the submodules the branch moved, drawn as a tree of text lines, each entry with its pull request and commit links. Empty where the session made no commits
standinglist[string]No[]One line for each repository whose pull request this close did not simply write to: one already merged or closed, which is left alone, and one whose pull request merged and which has committed since
warningslist[string]No[]What was found in a repository whose pull request has already merged or closed that its branch can no longer carry, one line each. The close still succeeds
callTimingslist[timingEntry]No[]One row for each timed model call the close made: its label, how long it took, and the repository it was made for
modelTimingslist[modelTiming]No[]The model-call record across sessions, one row per task and model, ordered by modelTableSort
sessionModelTimingslist[modelTiming]No[]The same rows counted over the calls made since this session opened
checkAverageslist[checkAverage]No[]What each check and test run has cost over the issue and how often it passed, as the runner measured them from the commands' own records
timingslist[recordedMeasurement]No[]The durations the session chose to report for its own actions, each with the increment it was reported in
planWeeklyCostnumberNo0What the configured planMonthlyCost comes to over one seven-day window, in the same currency, which the session's model-call table prices plan usage against. 0 where no price is configured