tractorbeam change-request
The Tractorbeam API's change request operations.
tractorbeam change-request <subcommand> [flags]
Shared flags
Every subcommand takes these flags.
| Flag | Description |
|---|---|
--config <string> |
The Project’s tractorbeam.config.ts. Defaults to the one in the current directory or its nearest ancestor. |
--workspace <string> |
Workspace name. Environment variable: TRACTORBEAM_WORKSPACE. |
--origin <string> |
The Tractorbeam origin to call instead of the default, such as a proxy’s. Environment variable: TRACTORBEAM_ORIGIN. |
--token <string> |
Access token. Defaults to the saved interactive session. Environment variable: TRACTORBEAM_TOKEN. |
change-request list
Returns a page of the Workspace’s change requests, newest first.
tractorbeam change-request list [flags]
| Flag | Description |
|---|---|
--limit <string> |
The most items the page returns, from 1 to 200. Defaults to 50. |
--cursor <string> |
A cursor for use in pagination: the nextCursor of the previous page, whose read the page continues. |
--all |
Read every page, following nextCursor, and print all their items together. |
change-request create
Opens a change request to merge the source Branch into the target. Both Branches must exist and differ.
tractorbeam change-request create [flags]
| Flag | Description |
|---|---|
--title <string> |
What the change request changes; surrounding whitespace is trimmed. |
--description <string> |
|
--source-branch <string> |
A Resource’s name, as its definition writes it: 1 to 56 letters, digits, -, and _, starting with a letter and ending with a letter or a digit, such as addNote, add_note, or customer-order. Names are case-sensitive. |
--target-branch <string> |
A Resource’s name, as its definition writes it: 1 to 56 letters, digits, -, and _, starting with a letter and ending with a letter or a digit, such as addNote, add_note, or customer-order. Names are case-sensitive. |
--json <json> |
The body’s fields as one JSON object. Flags given as well override its fields. |
change-request get
tractorbeam change-request get [flags] <change-request>
| Argument | Description |
|---|---|
<change-request> |
A canonical UUIDv7 TypeID. |
change-request close
Closes an open change request without merging it. Closing a closed one again leaves it unchanged; a merged one returns 409.
tractorbeam change-request close [flags] <change-request>
| Argument | Description |
|---|---|
<change-request> |
A canonical UUIDv7 TypeID. |
change-request merge
Merges the change request’s source Branch into its target, as merging the Branches does: a dry run plans the merge and lists each conflict with its value on each Branch. Confirming the merge resolves each conflict and writes one merge Commit, and the change request then records it. A closed or already merged change request returns 409.
tractorbeam change-request merge [flags] <change-request>
| Argument | Description |
|---|---|
<change-request> |
A canonical UUIDv7 TypeID. |
| Flag | Description |
|---|---|
--dry-run |
Whether to plan the merge and commit nothing. |
--expected-head <json> |
The ID of the target Branch’s Commit the plan is made against. A confirmed merge must name it. |
--source-head <json> |
The ID of the source Branch’s Commit the plan merges. Required in a confirmed merge. |
--resolutions <json> |
The resolution of each conflict. A confirmed merge needs one for every conflict. |
--acknowledged-plan-digest <json> |
The planDigest of the dry run this request confirms. A destructive plan needs it. |
--json <json> |
The body’s fields as one JSON object. Flags given as well override its fields. |