Renovate の platformAutomerge を検証

[suzuki-shunsuke]

以前期待通り動かなかった気がするが、改めて検証する。

https://docs.renovatebot.com/configuration-options/#platformautomerge

https://github.com/suzuki-shunsuke/test-renovate-platformautomerge

[suzuki-shunsuke]

何も CI が走っていないからか automerge されない。

https://github.com/suzuki-shunsuke/test-renovate-platformautomerge/pull/1

[suzuki-shunsuke]

CI pass したがマージされない。 branch の設定がしてないから？ https://github.com/suzuki-shunsuke/test-renovate-platformautomerge/pull/3

DEBUG: GitHub-native automerge: not enabled in repo settings(branch="renovate/cli-cli-2.x")

https://app.renovatebot.com/dashboard#github/suzuki-shunsuke/test-renovate-platformautomerge/554977790

リポジトリの設定が必要？

https://github.com/renovatebot/renovate/blob/eccfa6514f719772d5d1f0353993f7644469841f/lib/platform/github/index.ts#L1469-L1475

  if (!config.autoMergeAllowed) {
    logger.debug(
      { prNumber },
      'GitHub-native automerge: not enabled in repo settings'
    );
    return;
  }

https://github.com/renovatebot/renovate/blob/eccfa6514f719772d5d1f0353993f7644469841f/lib/platform/github/index.ts#L256-L264

    const res = await githubApi.requestGraphql<{
      repository: GhRepo;
    }>(infoQuery, {
      variables: {
        owner: config.repositoryOwner,
        name: config.repositoryName,
      },
    });
    repo = res?.data?.repository;

https://docs.github.com/en/graphql/reference/objects#repository

autoMergeAllowed (Boolean!) | Whether or not Auto-merge can be enabled on pull requests in this repository.

そういえばこんなリポジトリの設定あったの忘れていた。

You can allow setting pull requests to merge automatically once all required reviews and status checks have passed. Allow auto-merge Waits for merge requirements to be met and then merges automatically.

https://docs.github.com/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request

[suzuki-shunsuke]

Allow auto-merge を有効化したが、マージされない。

https://github.com/suzuki-shunsuke/test-renovate-platformautomerge/pull/4

失敗している

https://app.renovatebot.com/dashboard#github/suzuki-shunsuke/test-renovate-platformautomerge/554977867

DEBUG: GitHub-native automerge: fail(branch="renovate/cli-cli-2.x")
{
  "prNumber": 4,
  "errors": [
    {
      "type": "UNPROCESSABLE",
      "path": [
        "enablePullRequestAutoMerge"
      ],
      "locations": [
        {
          "line": 6,
          "column": 3
        }
      ],
      "message": "[\"Pull request is not in the correct state to enable auto-merge\"]"
    }
  ]
}

Web UI 上も automerge を有効化できる感じではない

これはすでに merge できる状態だからか。

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request

Note: the option to enable auto-merge is shown only on pull requests that cannot be merged immediately.

[suzuki-shunsuke]

main branch に branch protection rule を作る。 なにも選ばずに Require status checks to pass before merging を有効化してみる

[suzuki-shunsuke]

automerge 有効化できない

https://github.com/suzuki-shunsuke/test-renovate-platformautomerge/pull/5

[suzuki-shunsuke]

追加してみる。 GitHub Actions の場合、 job 名を選ぶのか？ job 名重複したら status check どうなるんだろ。

[suzuki-shunsuke]

有効になった。

https://github.com/suzuki-shunsuke/test-renovate-platformautomerge/pull/6

そしてマージされた。

[suzuki-shunsuke]

実現したいことは、実行されるすべての job が pass したら自動でマージされること。 branch protection rule で指定した job が pass した時点で他の job を無視してマージされたら困るが、 そのへんはどうなっているのか要確認。これは Renovate 関係なく、 GitHub の Automerge の仕様の話。

[suzuki-shunsuke]

必ず失敗する workflow を追加して検証

[suzuki-shunsuke]

CI こけてるのにマージされてしまった。

https://github.com/suzuki-shunsuke/test-renovate-platformautomerge/pull/7