docs: add deprecation workarounds documentation for allow_inplace_checks
#7215
+20
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🔴 👀 Review RequirementsThis rule is failing.
🔴 🔎 ReviewsThis rule is failing.
🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 Changelog requirementsWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
…ecks` As we're going to deprecate `allow_inplace_checks`, we need to create a documentation so the users can implement a workaround. The link to this documentation will be inserted in the deprecation notice afterward.
Syffe
force-pushed
the
allow_inplace_depre
branch
from
cede93f to
8b5a390
Compare
jd
reviewed
May 27, 2025
Comment on lines
+114
to
+117
| 2. If draft PRs are not an issue for you, but you want to preserve you commit history by avoiding merge commit shas, | ||
| you can setup your merge queue to use the `fast-forward` mode for the attribute `merge_method`. | ||
| This way, the merge queue will keep the linearity of your commit history. | ||
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. |
There was a problem hiding this comment.
Suggested change
| 2. If draft PRs are not an issue for you, but you want to preserve you commit history by avoiding merge commit shas, | |
| you can setup your merge queue to use the `fast-forward` mode for the attribute `merge_method`. | |
| This way, the merge queue will keep the linearity of your commit history. | |
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. | |
| 2. If draft PRs are not an issue for you, but you want to preserve your the sha used to run CI jobs, | |
| you can setup your merge queue to use the `fast-forward` mode for the attribute `queue_branch_merge_method`. | |
| This way, no untested commit sha will be merged. | |
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. |
jd
reviewed
May 27, 2025
Comment on lines
+119
to
+124
| 3. If draft PRs are not an issue for you, but you want to limit their amount, you can choose to leverage | ||
| the `batch_size` and `speculative_checks` attributes in your `queue_rules`. | ||
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. | ||
|
|
||
| For any further questions, feel free to <a href="mailto:[email protected]">Contact our support</a>. | ||
|
|
There was a problem hiding this comment.
I don't think the amount is a new problem.
Suggested change
| 3. If draft PRs are not an issue for you, but you want to limit their amount, you can choose to leverage | |
| the `batch_size` and `speculative_checks` attributes in your `queue_rules`. | |
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. | |
| For any further questions, feel free to <a href="mailto:[email protected]">Contact our support</a>. | |
| For any further questions, feel free to <a href="mailto:[email protected]">contact our support team</a>. | |
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. | ||
|
|
||
| 3. If draft PRs are not an issue for you, but you want to limit their amount, you can choose to leverage | ||
| the `batch_size` and `speculative_checks` attributes in your `queue_rules`. |
There was a problem hiding this comment.
I wouldn't mention speculative checks. First, because we should use max_parallel_checks instead of speculative_checks. And parallel checks create more draft PRs. The only option that reduces draft PRs is batch_size.
JulianMaurin
reviewed
Jun 5, 2025
There was a problem hiding this comment.
I would suggest a different format, with subtitles instead of numbers and more details/information to help users to understand the change
Suggested change
| ### `allow_inplace_checks` deprecation notice | |
| /a small note about the motivation of the change/ | |
| #### Preserving commit history | |
| Set up your merge queue to use the `fast-forward` mode for the attribute `queue_branch_merge_method`. | |
| This way, no untested commit SHA will be merged. | |
| See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details. | |
| #### Preventing Mergify draft PRs | |
| /a small note to encourage users to adopt the draft PR, finishing by something like "but since we understand that it could be an issue for your workflow, there is an alternative .../ | |
| ... you can leverage the [Workflow Automation](/workflow/) feature with the [rebase](/workflow/actions/rebase/) and [merge](/workflow/actions/merge/) actions. This way, once a pull request validates your rules, you can directly rebase and merge it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As we're going to deprecate
allow_inplace_checks, we need to create a documentation so the users can implement a workaround. The link to this documentation will be inserted in the deprecation notice afterward.