Turn on merge queues

[surchs]

The overhead of dependabot PRs is mainly having to wait for them to go back to green after the previous one merged.
Github auto-merge can help, because it will automatically merge PRs once all requirements are met.

Tasks

• identify the workflows that need to (re-) run in a merge queue
• update these workflows with the merge_group event trigger
• manually update non-synced workflows in these repos
  • https://github.com/neurobagel/query-tool
  • https://github.com/neurobagel/federation-api
  • https://github.com/neurobagel/api
  • https://github.com/neurobagel/bagel-cli

Something to look into:

• if I approve two bot PRs, does the CI for the second one run again after the first one was merged?
• if I allow an external PR to auto-merge, and then the author makes accepts some code suggestions from me, do I have to re-enable the merge / merge manually

edit:
old and incomplete view:
That's what merge queues are for (and hopefully that works here to): https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue

So let's turn them on and let GitHub manage the merge sequence

[surchs]

I think I misunderstood this partly. What I am looking for is more "auto-merging": https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request

Merge queues are also nice, but they address a problem that we don't have yet: how to merge a lot of PRs one after the other, if the CI for each PR takes a lot of time.

I think we can still enable merge queues if we want to (we now have them in https://github.com/neurobagel/react-bagel) but this issue should be about whether we want auto-merges turned on.

For us auto-merge would mean:

• unless you explicitly disable it on your own PR, the PR will by default merge as soon as all checks are green, you are approved, and all other requirements are met

For external contributors it would mean:

• we need to enable auto-merge for their PRs
• and then the PR auto merges as well, unless they make another commit

[surchs]

Some things we've learned already:

• auto-merge runs once all checks and requirements are met
• however: auto-merge does not rerun checks if the target branch has been pushed since the last check, and it also doesn't auto-merge / update PR branches

So for these things, you'd still want a merge queue

[surchs]

https://medium.com/@kojoru/how-to-set-up-merge-queues-in-github-actions-59381e5f435a

[surchs]

Shared workflows we want to run on merge queues:

• none (so far)

Repo specific workflows we want to run on merge queues

• query
  • codespell (should be synced)
  • component test
  • e2e test -> these should be both in one workflow and they should use coverage like in our react template
  • lint
  • prettier -> they should both be in one workflow and also synced to all react repos!
  • codespell (see above)
• n-api
  • codespell (see above)
  • test
• f-API
  • codespell (see above)
  • lint -> should be synced to all python repos
  • test
• cli
  • codespell (see above)
  • test

[surchs]

moving this issue to tracked until we address the following workflows issues:

• Add codespell as a synced workflow workflows#90
• Add flake8 to synced workflows workflows#91
• Add nightly docker build to synced workflows workflows#92
• Add pytest workflows to synced workflows workflows#93

Addressing these issues will also implicitly resolve the merge_queue issue but by making one change instead of 4 or 5

[surchs]

Closing as we don't (yet) have very long running checks