# set\_forge\_pull\_request\_auto\_merge

Turn a pull request's auto-merge on or off on its forge.

writes · idempotent · destructive · CLI only · [Forge](https://komrad.dev/latest/api/forge.md)

## Calling it

```bash
curl -X POST http://127.0.0.1:8787/komrad.forge.v1.ForgeService/SetForgePullRequestAutoMerge \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "<url>"
}'
```

```bash
komrad rpc set-forge-pull-request-auto-merge \
  --url '<string>'
```

## Request

### SetForgePullRequestAutoMergeRequest

| Field | Type | Description |
| --- | --- | --- |
| [`url`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-SetForgePullRequestAutoMergeRequest-url) | string\* at most 2048 characters | The pull request to change, by web address. The address's host picks the forge connection. |
| [`head_sha`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-SetForgePullRequestAutoMergeRequest-head_sha) | string at most 64 characters | The head commit the caller expects. The forge refuses to turn auto-merge on once the branch has moved past it. Empty accepts any head. |
| [`on`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-SetForgePullRequestAutoMergeRequest-on) | bool | Whether the pull request merges by itself once its checks and reviews pass. |
| [`method`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-SetForgePullRequestAutoMergeRequest-method) | [MergeMethod](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-MergeMethod) | How the pull request merges once it may. Unspecified merges by a method the base branch allows. |
| [`headline`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-SetForgePullRequestAutoMergeRequest-headline) | string not empty at most 1024 characters | The first line of the commit the merge writes. Unset leaves it to the forge. |
| [`body`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-SetForgePullRequestAutoMergeRequest-body) | string at most 65536 characters | The rest of the commit the merge writes. Unset leaves it to the forge, and empty writes a headline alone. |

## Response

### Empty

No fields.

## Types

### MergeMethod

MergeMethod is how a pull request's commits land on its base branch.

| Value | Description |
| --- | --- |
| [`merge`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-MergeMethod-merge) | The commits land under a merge commit. |
| [`squash`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-MergeMethod-squash) | The commits land as one new commit. |
| [`rebase`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-MergeMethod-rebase) | The commits are replayed onto the base branch one by one. |
| [`fast_forward`](https://komrad.dev/latest/api/forge/set-forge-pull-request-auto-merge.md#komrad-forge-v1-MergeMethod-fast_forward) | The base branch moves to the head commit, without a commit of its own. |
