How to disable automerge when creating a deployment

[sigfrid]

Select Topic Area

Question

Body

I'm trying to create a deployment via the GitHub API.

According to the documentation:

auto_merge boolean

Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

Default: true

Since I don't want automerge, I passed false as parameter

gh api \
  --method POST \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/${{ github.repository }}/deployments \
    -f "ref=123"
    -f "auto_merge=false"

But I still get:

gh: Conflict merging main into 123. (HTTP 409)
{"message":"Conflict merging main into 123.","documentation_url":"https://docs.github.com/rest/deployments/deployments#create-a-deployment","status":"409"}

What am I missing here?

Thanks.

[Satyatma1]

You need to pass false as a raw JSON boolean, not a string. The gh api command allows raw JSON input via --input or --raw-field.
Maybe u can try this out :
gh api
--method POST
-H "Accept: application/vnd.github+json"
-H "X-GitHub-Api-Version: 2022-11-28"
/repos/${{ github.repository }}/deployments
--raw-field ref=123
--raw-field auto_merge=false

[sigfrid]

Unfortunately, I got the same outcome.

Looking at https://cli.github.com/manual/gh_api

The -F/--field flag has magic type conversion based on the format of the value:

literal values true, false, null, and integer numbers get converted to appropriate JSON types;
placeholder values {owner}, {repo}, and {branch} get populated with values from the repository of the current directory;
if the value starts with @, the rest of the value is interpreted as a filename to read the value from. Pass - to read from standard input.

Therefore, I updated my code as

gh api \
  --method POST \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/${{ github.repository }}/deployments \
    -F ref='123'
    -F auto_merge='false'

However, I still receive the conflict error.

So, I switched to curl and it works.

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer ${{ github.token }}" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/${{ github.repository }}/deployments \
  -d '{"ref":"123","auto_merge":false}'