Skip to content

GH-55475: [Dev] Use merge button instead of merge script - #55484

Open
rok wants to merge 3 commits into
apache:mainfrom
rok:gh-55475-merge-button
Open

rok wants to merge 3 commits into
apache:mainfrom
rok:gh-55475-merge-button

Conversation

@rok

@rok rok commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

Rationale for this change

Committers need a personal access token and dev/merge_arrow_pr.py to merge. This lets them use the "Squash and merge" button instead, like apache/arrow-rs does.

This is stacked on #55474. Its commit is the first one here, so the diff also shows its files: .github/boring-cyborg.yml, .github/pull_request_template.md and the removed .github/workflows/dev_pr.yml and .github/workflows/dev_pr/. Only the second commit is this pull request. It must not be merged before #55474: see "Things to discuss".

What changes are included in this PR?

  • .asf.yaml: the "PR Title" status of the Boring Cyborg app (GH-55473: [Dev] Add boring-cyborg app configuration and remove dev_pr.yml workflow #55474) becomes a required status check of main. The merge is blocked unless the title starts with GH-XXX or MINOR: .

  • .github/workflows/dev_pr_merged.yml (new): runs on pushes to main. If the pushed commit is the merge commit of a GH-XXX: ... pull request, it:

    • assigns the issue to the pull request author if nobody is assigned,
    • sets the milestone of the issue: the milestone of the pull request if it has one, otherwise the issue keeps its milestone, otherwise the next major release without a maintenance branch (the default of the merge script),
    • closes the issue and comments "Issue resolved by pull request XXX" after that.

    It does nothing for MINOR: ... pull requests. It's a single gh step, without custom scripts or third-party actions.

  • dev/README.md, docs/source/developers/overview.rst, docs/source/developers/continuous_integration/overview.rst: describe the merge button and the new workflow instead of requiring the merge script.

  • docs/source/developers/release.rst: the required check rejects direct pushes to main, so the "Bump versions" step now says to run post-10-bump-versions.sh with BUMP_PUSH=0 BUMP_TAG=0, create a MINOR: [Release] ... pull request from the commits and tag the merged commit by hand.

Not changed: the merge script, the release scripts and the merge button settings (apache/arrow already allows only squash merges with the pull request title and description as the commit message).

Things to discuss

  • Order: if the required "PR Title" check is enabled before the Boring Cyborg app reports it on apache/arrow, nothing can be merged to main. Merging also depends on the app being up.
  • Strictness: the app only checks how the title starts (WIP: GH-XXX, a missing [Component] and a missing : pass), and nothing checks before the merge that the issue exists and is open. The rule could be tightened in .github/boring-cyborg.yml.
  • Release: the version bump is a pull request now, so the changelog and version commits are squashed into one commit. Running post-10-bump-versions.sh without BUMP_PUSH=0 BUMP_TAG=0 fails at the push.
  • Partial fixes: the issue is always closed on merge, so a pull request that covers only a part of an issue can't keep it open.
  • Commit message: button merges don't have Authored-by:/Signed-off-by: trailers (GitHub adds Co-authored-by:), so "Patch Committers" in the release announcement, which counts Signed-off-by:, needs a follow-up. The description isn't cleaned unless the committer does it in the merge dialog.
  • [skip ci]: GitHub doesn't run the new workflow for a merge commit with a CI directive in its message (4 of the last 2000 commits on main), so the issue has to be closed manually then.
  • Merge script: it still works and is bound by the required check too. The new workflow also runs for its merges and skips what the script has already done, but the issue may get the "Issue resolved by pull request XXX" comment twice if both comment at the same time.

Are these changes tested?

Only locally: a dry run of the workflow step against apache/arrow (real merged commits and faked issue states, with the writes printed instead of executed). The workflow and the required check can only run once this is on main. The manual release steps in the guide have not been tried.

Are there any user-facing changes?

No.

Was AI used for this PR?

PR code and description written by:

  • Human
  • AI

Reviewed before submission by:

  • Human
  • AI
  • Not reviewed

@rok rok changed the title GH-55475: [Dev] Use merge button instead of merge script WIP: GH-55475: [Dev] Use merge button instead of merge script Nov 10, 2026
@rok rok changed the title WIP: GH-55475: [Dev] Use merge button instead of merge script WIP: GH-55475: [Dev] Merge pull requests with a comment instead of the merge script Nov 10, 2026
@rok rok changed the title WIP: GH-55475: [Dev] Merge pull requests with a comment instead of the merge script WIP: GH-55475: [Dev] Use merge button instead of merge script Nov 10, 2026
@rok
rok force-pushed the gh-55475-merge-button branch from 4b8ed1c to c34e788 Compare November 10, 2026 21:02
@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #55475 has been automatically assigned in GitHub to PR creator.

@rok
rok force-pushed the gh-55475-merge-button branch 5 times, most recently from a681b72 to 8af40b8 Compare November 10, 2026 22:43
@rok rok changed the title WIP: GH-55475: [Dev] Use merge button instead of merge script GH-55475: [Dev] Use merge button instead of merge script Nov 10, 2026
@rok
rok force-pushed the gh-55475-merge-button branch 2 times, most recently from 96ffdb2 to 3a6799e Compare November 10, 2026 23:14
@rok
rok marked this pull request as ready for review November 10, 2026 23:24
Copilot AI balanced review requested due to automatic review settings November 10, 2026 23:24

This comment was marked as outdated.

@rok
rok force-pushed the gh-55475-merge-button branch from 3a6799e to 65e2f5a Compare November 10, 2026 23:41
Copilot AI balanced review requested due to automatic review settings November 10, 2026 23:41

This comment was marked as resolved.

@rok
rok force-pushed the gh-55475-merge-button branch from 65e2f5a to 36ac2dd Compare November 11, 2026 09:17
Copilot AI balanced review requested due to automatic review settings November 11, 2026 09:17

This comment was marked as resolved.

@rok
rok force-pushed the gh-55475-merge-button branch from 22f4699 to 256db9b Compare November 11, 2026 10:44
Copilot AI balanced review requested due to automatic review settings November 11, 2026 10:44

This comment was marked as resolved.

@rok
rok requested a balanced review from Copilot November 11, 2026 10:58

This comment was marked as low quality.

@rok
rok force-pushed the gh-55475-merge-button branch from 256db9b to f1c623f Compare November 11, 2026 11:25
Copilot AI balanced review requested due to automatic review settings November 11, 2026 11:25

This comment was marked as low quality.

@rok
rok force-pushed the gh-55475-merge-button branch from f1c623f to 423b612 Compare November 11, 2026 11:49
Copilot AI balanced review requested due to automatic review settings November 11, 2026 11:49

This comment was marked as low quality.

@rok
rok force-pushed the gh-55475-merge-button branch from 423b612 to 227840b Compare November 11, 2026 12:15
Copilot AI balanced review requested due to automatic review settings November 11, 2026 12:15

This comment was marked as low quality.

@rok
rok force-pushed the gh-55475-merge-button branch from 227840b to 1725e0f Compare November 11, 2026 12:21
Copilot AI balanced review requested due to automatic review settings November 11, 2026 12:21

This comment was marked as low quality.

Document the "Squash and merge" button as the way to merge pull
requests. The merge script is still available.

Before the merge, the "PR Title" status of the Boring Cyborg app is a
required status check on main: the pull request title must start with
"GH-XXX" or "MINOR: ".

The required check rejects direct pushes to main, so the release
guide tells release managers to bump versions with a pull request.

After the merge, a workflow for pushes to main assigns the issue to
the pull request author if it isn't assigned, sets its milestone,
closes it and comments which pull request resolved it.
@rok
rok force-pushed the gh-55475-merge-button branch from 1725e0f to f37b26b Compare November 11, 2026 12:49
Copilot AI balanced review requested due to automatic review settings November 11, 2026 12:49

This comment was marked as low quality.

@rok

rok commented Nov 12, 2026

Copy link
Copy Markdown
Member Author

@Reranko05 What do you think about this? (Note this is a stacked PR, the actual change is only f37b26b).

@Reranko05 Reranko05 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't looked too deeply into the logic, but I left a couple of minor documentation suggestions. Nothing major!

(Although this doesn't apply to me just yet, hopefully it will someday 😅)

Comment thread dev/README.md Resolved
Comment thread docs/source/developers/overview.rst Resolved
Copilot AI balanced review requested due to automatic review settings November 15, 2026 16:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@rok
rok requested a review from Reranko05 November 15, 2026 17:03

@Reranko05 Reranko05 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I looked through the workflow changes, and nothing stands out to me :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants