komrad

plan_push

Preview a push of a task's branch to origin without pushing anything.

writesnot idempotentdestructiveCLI onlyAgent

Calling it#

curl -X POST http://127.0.0.1:8787/komrad.agent.v1.AgentService/PlanPush \
  -H 'Content-Type: application/json' \
  -d '{
  "task_id": "<task_id>"
}'

Request#

PlanPushRequest#

PlanPushRequest asks what a push of a task's branch would do, without doing it.

FieldTypeDescription
one of*

The task whose branch to plan a push of.

task_iduuid

The task, by id.

task_slugstring

not empty

The task, by slug.

Response#

PlanPushResponse#

FieldTypeDescription
branchstring

The branch that would be pushed.

commitsint32

How many commits would be pushed, counted against origin's copy of the branch, or against the base branch when origin has none.

forcedbool

Whether origin's copy has commits the branch does not, which the push would overwrite.

uncommitted_filesint32

How many files have changes that are not committed and would not be pushed.

in_syncbool

Whether origin already has every commit on the branch.