tools: use GitHub Squash and Merge feature when using CQ

[aduh95]

GitHub REST API allows us to edit the commit message when using "Squash and Merge" feature, that would allow the CQ to "purple merge" PRs without needing to force-push to the user branch when the PR contains one commit max.

I've tested locally with nodejs/node-auto-test#37, I also tried to test it using the CQ in nodejs/node-auto-test#40 but the CQ is not working there. I think we should land this, and revert if it's broken.

Refs: https://docs.github.com/en/rest/reference/pulls#merge-a-pull-request

[richardlau]

I've tested locally with nodejs/node-auto-test#37, I also tried to test it using the CQ in nodejs/node-auto-test#38 but the CQ is not working there.

Maybe the repository check in the workflow?

node/.github/workflows/commit-queue.yml

Line 21 in b5aa08d

if: github.repository == 'nodejs/node'

[aduh95]

I've tested locally with nodejs/node-auto-test#37, I also tried to test it using the CQ in nodejs/node-auto-test#38 but the CQ is not working there.

Maybe the repository check in the workflow?

node/.github/workflows/commit-queue.yml

Line 21 in b5aa08d

if: github.repository == 'nodejs/node'

I've tried removing this check, but there are missing repo secrets, I don't know what values I should use: https://github.com/nodejs/node-auto-test/runs/4059202773?check_suite_focus=true

[targos]

Try to replace secrets.GH_USER_TOKEN with the default secrets.GITHUB_TOKEN

[targos]

Wouldn't the script be easier to read and write if we used the github CLI instead of calling the API manually? The CLI is installed on the runners by default

[aduh95]

Wouldn't the script be easier to read and write if we used the github CLI instead of calling the API manually?

Maybe, maybe not. For merging PRs, the CLI doesn't provide the options to do that (see cli/cli#4645) so we'd have to defer to gh api and that wouldn't help readability much here.
For the other commands, I'd defer to @mmarchini's opinion there might be a good reason she chose curl.

[aduh95]

The CQ has landed successfully nodejs/node-auto-test#43, including the Landed in… comment. Is there anything in particular I should be testing to have this ready for landing? Or if someone else wants to do their own testing, by all means go try yourself on node-auto-test (I can share credentials for @aduh95-test-account if that helps).

[targos]

@nodejs/actions

[mmarchini]

Ohhh that's an interesting approach to purple merge vs red close a PR without resorting to force-push to the developer's branch.

As for gh vs curl: I think it makes sense as part of a refactor to change everything to use gh instead of curl (even for squashing, for consistency).

@targos wdyt about suggesting a gh api call that uses this same approach on node-core-utils as part of the last steps when merging? That way we can get purple merges even when folks don't use CQ.

[targos]

@targos wdyt about suggesting a gh api call that uses this same approach on node-core-utils as part of the last steps when merging? That way we can get purple merges even when folks don't use CQ.

SGTM, I'll look into it as soon as the script here is refactored to use gh.

[github-actions]

Landed in 19839f8...80b8440