Enable merge queues on scikit-image GitHub repo

lagru · February 21, 2023, 5:23pm

GitHub recently added a new feature: Pull request merge queue (public beta)

– [Managing a merge queue - GitHub Docs]
Once a pull request has passed all of the required branch protection checks, a user with write access to the repository can add that pull request to a merge queue. […] The merge queue creates temporary branches with a special prefix to validate pull request changes. The changes in the pull request are then grouped into a merge_group with the latest version of the base_branch as well as changes ahead of it in the queue. GitHub will merge all these changes into base_branch once the checks required by the branch protections of base_branch pass.

@stefanv brought it up in a meeting and I concur: I think it would be useful to have and might offer some convenience for the “I’ll merge once the CI is green” cases. I’ll wait a week for input and enable the setting if nobody voices any concerns.

lagru · February 28, 2023, 12:14pm

See

github.com/scikit-image/scikit-image

Prepare CI configuration for merge queue

scikit-image:main ← lagru:enable-merge-queue

opened 12:13PM - 28 Feb 23 UTC

lagru

+2 -2

## Description As proposed on our [dev forum](https://discuss.scientific-pyth…on.org/t/enable-merge-queues-on-scikit-image-github-repo/660), we plan to enable merge queues for our pull requests. With this GitHub feature enabled, pull requests can be added to a merge queue. GitHub then creates a temporary branch between pull request and target branch (main) and runs the checks. This might offer some convenience for the “I’ll merge once the CI is green” cases. GitHub sends a different event when a pull request is added to a merge queue, so we need to update our CI configuration to trigger on "merge_group" events: - [x] For our GitHub action workflows we can do so by simply adding `merge_group` to the trigger `on` list ([see docs](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#triggering-merge-group-checks-with-github-actions)). - [x] For CircleCI, the event "Merge groups" needs to be enabled under Repo settings » Webhooks. I already did so. - [ ] For Azure Pipelines, I'm not sure yet. Because we don't have a `trigger` field in our configuration file I'm assuming that we use ["classic" CI triggers](https://learn.microsoft.com/en-us/azure/devops/pipelines/repos/github?view=azure-devops&tabs=classic#ci-triggers) which need to be updated to trigger on the branch specification `gh-readonly-queue/{base_branch}`. @stefanv can you do that or give me access to do it? - [x] I think we don't need to update the webhook to Codecov, as the [scikit-image repo is deactivated on Codecov](https://app.codecov.io/gh/scikit-image). - [x] All other workflows don't trigger on pull requests (use `pull_request` event). ## Checklist - [Docstrings for all functions](https://github.com/numpy/numpy/blob/master/doc/example.py) - Gallery example in `./doc/examples` (new features only) - Benchmark in `./benchmarks`, if your changes aren't covered by an existing benchmark - Unit tests - Clean style in [the spirit of PEP8](https://www.python.org/dev/peps/pep-0008/) - Descriptive commit messages (see below) ## For reviewers - Check that the PR title is short, concise, and will make sense 1 year later. - Check that new functions are imported in corresponding `__init__.py`. - Check that new features, API changes, and deprecations are mentioned in `doc/release/release_dev.rst`. - There is a bot to help automate backporting a PR to an older branch. For example, to backport to v0.19.x after merging, add the following in a PR comment: `@meeseeksdev backport to v0.19.x` - To run benchmarks on a PR, add the `run-benchmark` label. To rerun, the label can be removed and then added again. The benchmark output can be checked in the "Actions" tab.

lagru · March 14, 2023, 9:16pm

FYI, the PR just got merged and I enabled merge queues for the main branch. If there are any problems you can disable the feature again under the branch settings for the scikit-image repo.

lagru · March 16, 2023, 4:41pm

FYI2, I’ve disabled merge queues again. It seems like the current feature (beta) doesn’t allow to edit the squashed commit message. I’d say that’s a no-go.

lagru · March 16, 2023, 4:43pm

Sorry for the back and forth. Maybe they add that feature in the future.

stefanv · March 17, 2023, 5:25pm

Thanks for exploring this option, Lars.