Move landchecks to deprecated section, add info about new landchecks, which should be moved elsewhere when possible

clee2000
2022-11-28 13:35:21 -08:00
parent fcceb3cefd
commit bb453ab35b

@ -4,26 +4,6 @@ Updated on: 8/30/22
Please report any buggy instances to @pytorch/pytorch-dev-infra asynchronously or join our [Office Hours](https://github.com/pytorch/pytorch/wiki/Dev-Infra-Office-Hours) to give in-person feedback or get in-person help!
# Land Checks
Land checks offer extra validation to your PR by rebasing a copy of your changes on top of the latest `viable/strict` branch and ensuring they still pass pull + trunk workflows.
Benefit: You get higher confidence that your PR won't have to be reverted after being merged into master!
Caveat: Slower merges: Once you run the merge command you'll still need to wait for the land checks branch to build and pass all checks
If you have the ciflow/trunk tag on your PR, no extra checks will be run since you've already passed all the checks that would've been attempted.
We are currently rolling out land checks to all of the users in this [list](https://github.com/pytorch/test-infra/blob/main/torchci/lib/bot/rolloutUtils.ts).
If you find rough edges with the land validation:
- Please file an issue to call it out to us!
- You can revert back to the old behavior by invoking `@pytorchmergebot merge -g`, which will only for checks on the PR to pass (which is usually just pull and lint workflows).
- If you believe there's some infra flakiness preventing you from landing, you can also use `-f` and supply a message.
Additionally, you can add the accept2run label to your PR to run land check signals when your PR gets approved so that the land process doesn't take as long. You can also add accept2ship if you want to land your PR as soon as your PR gets approved.
If you have any feedback or complaints, please reach out to the Pytorch OSS CI team or visit our [Office Hours](https://github.com/pytorch/pytorch/wiki/Dev-Infra-Office-Hours).
# PyTorchBot Help
```
usage: @pytorchbot [-h] {merge,revert,rebase} ...
@ -95,4 +75,33 @@ You can also add multiple labels using comments with pytorchbot.
```
@pytorchbot label label1,label2,etc
```
```
## Other
Upon calling `@pytorchbot merge`, we add the `ciflow/trunk` label to your PR which triggers trunk workflows to run more tests. This is our v2 of landchecks.
You can add the `accept2run` label to your PR to run land check signals when your PR gets approved so that the land process doesn't take as long. You can also add `accept2ship` if you want to land your PR as soon as your PR gets approved.
# Deprecated
<details><summary>Expand to see old features</summary>
# Land Checks
Land checks offer extra validation to your PR by rebasing a copy of your changes on top of the latest `viable/strict` branch and ensuring they still pass pull + trunk workflows.
Benefit: You get higher confidence that your PR won't have to be reverted after being merged into master!
Caveat: Slower merges: Once you run the merge command you'll still need to wait for the land checks branch to build and pass all checks
If you have the ciflow/trunk tag on your PR, no extra checks will be run since you've already passed all the checks that would've been attempted.
We are currently rolling out land checks to all of the users in this [list](https://github.com/pytorch/test-infra/blob/main/torchci/lib/bot/rolloutUtils.ts).
If you find rough edges with the land validation:
- Please file an issue to call it out to us!
- You can revert back to the old behavior by invoking `@pytorchmergebot merge -g`, which will only for checks on the PR to pass (which is usually just pull and lint workflows).
- If you believe there's some infra flakiness preventing you from landing, you can also use `-f` and supply a message.
If you have any feedback or complaints, please reach out to the Pytorch OSS CI team or visit our [Office Hours](https://github.com/pytorch/pytorch/wiki/Dev-Infra-Office-Hours).
<details>