Skip to content

Commit cede93f

Browse files
committed
docs: add deprecation workarounds documentation for allow_inplace_checks
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.
1 parent b179d88 commit cede93f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/content/docs/configuration/file-format.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,25 @@ The top-level key `queue_rules` allows to define the rules that reign over your
102102

103103
<OptionsTable def="QueueRuleModel" />
104104

105+
### Working around the `allow_inplace_checks` attribute deprecation
106+
107+
As the `allow_inplace_checks` attribute is deprecated, different choices are available.
108+
109+
1. If you want to merge your pull requests without the generation of draft PRs, you can leverage
110+
the [Workflow Automation](/workflow/) feature with the [rebase](/workflow/actions/rebase/) and [merge](/workflow/actions/merge/) actions.
111+
This way, once a pull request validates your rules, you can directly rebase and merge it.
112+
113+
2. If draft PRs are not an issue for you, but you want to preserve you commit history by avoiding merge commit shas,
114+
you can setup your merge queue to use the `fast-forward` mode for the attribute `merge_method`. This way, the merge queue
115+
will keep the linearity of your commit history.
116+
See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details.
117+
118+
3. If draft PRs are not an issue for you, but you want to limit their amount, you can choose to leverage
119+
the `batch_size` and `speculative_checks` attributes in your `queue_rules`.
120+
See the `queue_rules` [documentation](/configuration/file-format/#queue-rules) for more details.
121+
122+
For any further questions, feel free to <a href="mailto:[email protected]">Contact our support</a>.
123+
105124
### Priority Rules
106125

107126
The top-level key `priority rules` allows to define the rules that will determine

0 commit comments

Comments
 (0)