Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Schema Inaccuracy] "Merge a pull request", commit_message body parameter #4340

Copy link
Copy link
Open
@gsnedders

Description

@gsnedders
Issue body actions

Schema Inaccuracy

c.f. https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#merge-a-pull-request

https://github.com/github/rest-api-description/blob/50bf833eb2c1288fb78419d9e4d359fda3c3ccbe/descriptions/api.github.com/api.github.com.yaml#L36643-L36645

This documents:

commit_message string
Extra detail to append to automatic commit message.

However, it seems like, at least for the "squash" merge method, it replaces the commit_message, rather than appending it.

Expected

I hoped it would, like the behaviour of "Squash & Merge" in the Web UI, allow me to specify the entire commit message.

I fear it would, as documented, keep the auto-generated commit message and append a string there.

Reproduction Steps

gsnedders@gsnedders-lonnie tmp-symmetrical-meme % gh api \             
  --method PUT \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/gsnedders/tmp-symmetrical-meme/pulls/2/merge \
   -f "commit_title=Fix README" -f "commit_message=Will this be appended or replace the old body?" -f "merge_method=squash"

This merge entirely replaced the old body, rather than appended it as documented.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.