Skip to content

ci(mergify): upgrade configuration to current format#685

Open
mergify[bot] wants to merge 1 commit intomainfrom
mergify/configuration-deprecated-update
Open

ci(mergify): upgrade configuration to current format#685
mergify[bot] wants to merge 1 commit intomainfrom
mergify/configuration-deprecated-update

Conversation

@mergify
Copy link
Copy Markdown

@mergify mergify bot commented Apr 3, 2026

Hey there! 👋

We've noticed that your Mergify configuration is using some deprecated fields.

No worries—we've got your back! This automated PR updates your config to align with the newest standards, ensuring everything keeps running smoothly.

Do not procrastinate! You must upgrade your configuration before 2026-07-31, otherwise your configuration will stop working.

What's Changed?

  • The default value of merge_protections_settings.reporting_method is changing from check-runs to deployments. Your configuration has been updated to explicitly set check-runs to preserve current behavior. (deadline: 2026-07-31)

Why This Matters

Keeping your configuration up-to-date means you'll benefit from the latest features and improvements Mergify has to offer. Plus, it helps prevent any unexpected hiccups down the road.

Got Questions? We've Got Answers! 🙌

Is this update safe to merge?

Absolutely! We've made sure the changes are compatible with your current setup. Your workflows should continue to work just as before—if not better!

Do I need to do anything special after merging?

Nope! Just merge this PR, and you're all set. If you have any custom configurations, it's a good idea to give them a quick look to ensure everything's in order.

What if I run into issues or have concerns?

We're here to help! Feel free to reach out to our support team anytime.

Thanks for being awesome and keeping your configuration up-to-date! If you have any thoughts or need a hand, don't hesitate to let us know.

Happy merging! 🎉

@mergify
Copy link
Copy Markdown
Author

mergify bot commented Apr 3, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 📃 Configuration Change Requirements

Wonderful, this rule succeeded.

Mergify configuration change

  • check-success = Configuration changed

Copy link
Copy Markdown
Collaborator

@dbutenhof dbutenhof left a comment

Choose a reason for hiding this comment

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

the PR says we're "using deprecated fields" -- but all this actually does is add merge_protections_settings (it explains that the default has changed so it's explicitly setting the old default on which we presumably rely), and change the indentation of every single line (which is annoying).

It's probably worth investigating merge_protections_settings to be sure the old default / new explicit setting is really what we want: but aside from that ... I suppose this is OK to merge, but the wholesale spurious reformatting bothers me.

@jaredoconnell
Copy link
Copy Markdown
Collaborator

The new default may be fine. I don't have a strong opinion either way.

@dbutenhof
Copy link
Copy Markdown
Collaborator

The new default may be fine. I don't have a strong opinion either way.

The documentation says:

You can configure how Merge Protections report their status to GitHub using the reporting_method option in your configuration. This controls whether the protection status appears as a GitHub Check Run or as a Deployment.

Either

check-runs (default): Reports the protection status as a standard GitHub check on the pull request. This is the most common and compatible method.

or

deployments: Reports the protection status as a GitHub Deployment. This can be useful if your workflow or compliance requirements rely on deployment status.

We don't do "deployments" on PRs, and I feel like changing this default is a bit weird. On balance, I think I prefer keeping the existing behavior, which means overriding the new default.

Taking this PR is fine, although I think the reformatting is weird with the extra indentation. The alternative would be to close this PR and insert the actual two line change separately ... which seems a little excessive.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants