impl-tool pull-request create
Open and describe the pull requests for a branch that has none
- Command version
0.0.0- Command configuration
impl-tool:impl-tool.pull-request.create@0.0.0
Arguments
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--path | path | No | "." | Directory to act on (default: current directory) |
--branch | string | No | Branch to open pull requests for, taken literally. Defaults to the branch the issue is worked on, then to the branch the target directory is on. The checkout holding it is what the work is read from, whichever names it | |
--issue | string | No | Issue to open the pull requests for. Names the branch its work is on unless --branch says otherwise, and titles what is opened. Defaults to the session record's issue, then to the issue the branch is named after | |
--title | string | No | The issue's own title, for the pull request title when no description is written. Defaults to the session record's, then to what the branch's own commit subjects call the work | |
--base | string | No | Branch the pull requests are opened relative to (the checkout's configured default branch when not given) -- the same base the run would have used | |
--skip-submodule-pull-requests,--no-skip-submodule-pull-requests | boolean | No | false | Open one for the branch alone, leaving the submodules it moved without |
--skip-describe,--no-skip-describe | boolean | No | false | Write each body from the branch's commit subjects instead of asking a model to describe them -- no model call, and a worse pull request |
--pull-request-template-path | path | No | Path to a custom PR template (overrides the config file setting) |
It also takes the global arguments.
Output
It answers with a create.pullRequestCreateSummary.
Examples
impl-tool pull-request create --issue PROJ-0000123Open and describe the pull requests for the branch the issue is worked on, in the repository and each submodule it moved.
impl-tool pull-request create --issue PROJ-0000123 --skip-describeOpen them with bodies written from the branch's commit subjects, asking no model.
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. |
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. |
PULL_REQUEST_OPEN_FAILED | Opening or updating a pull request for the branch failed; what was opened before the failure is still reported, and the message carries the failure. | Repair what the message names -- a branch not pushed, access, quota -- and run pull-request create again. |
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. |
Types
create.pullRequestCreateSummary
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
issue | string | Yes | The id of the issue whose pull requests were opened. Empty where the command refused to act | |
branch | string | Yes | The branch the pull requests are for | |
pullRequest | string | No | "" | URL of the pull request for the branch in the repository the command acted in. Empty where it has none |
created | boolean | No | false | True where this call opened that pull request, false where it was already open |
tree | list[string] | No | [] | The repository and the submodules the branch moved, drawn as a tree of text lines, each entry with its pull request and commit links |
standing | list[string] | No | [] | One line for each repository whose pull request this call did not simply open: one already merged or closed, which is left alone, and one whose pull request merged and which has committed since, over which a fresh one is opened |
warnings | list[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 command still succeeds |
callTimings | list[timingEntry] | No | [] | One row for each timed model call the command made: its label, how long it took, and the repository it was made for |