[doc] add a doc page about ci testing workflow on a PR #45446
Conversation
|
let's hold off from adding the |
| @@ -0,0 +1,50 @@ | |||
| CI Testing Workflow on PRs | |||
There was a problem hiding this comment.
not sure about if the words in the middle of the title needs to be start with upper case or not. I see different / inconsistent conventions in the sidebar.
There was a problem hiding this comment.
good catch, i'm sticking to the most common styling then
There was a problem hiding this comment.
Could you install Vale? Our style guide is to sentence case headings. Thanks! https://anyscale-ray--45446.com.readthedocs.build/en/45446/ray-contribute/docs.html
There was a problem hiding this comment.
will do thankks
| is how I manually add tests in my pull request:: | ||
|
|
||
| // git command to add commit message | ||
| git commit -a -s |
There was a problem hiding this comment.
maybe don't add -a? probably should not encourage / tell user to use -a here as if -a is required for the workflow.
There was a problem hiding this comment.
what is your favorite workflow to add a git commit message? the -a is required to add a new commit message (there are similar alternatives like -m but they will need something)
|
@aslonnie's comments |
Signed-off-by: can <[email protected]>
| @@ -0,0 +1,52 @@ | |||
| CI Testing Workflow on PRs | |||
There was a problem hiding this comment.
| CI Testing Workflow on PRs | |
| CI testing workflow on PRs |
| ========================== | ||
|
|
||
| This guide helps contributors to understand the Continuous Integration (CI) | ||
| workflow on a PR. Here CI stands for the automated testing of the codebase |
There was a problem hiding this comment.
| workflow on a PR. Here CI stands for the automated testing of the codebase | |
| workflow on a PR. CI refers to the automated testing of the codebase |
|
|
||
| microcheck: default tests on your PR | ||
| ------------------------------------ | ||
| With every commit on your PR, by default, we'll run a set of tests |
There was a problem hiding this comment.
| With every commit on your PR, by default, we'll run a set of tests | |
| With every commit on your PR, by default, CI runs a set of tests |
| With every commit on your PR, by default, we'll run a set of tests | ||
| called `microcheck`. | ||
|
|
||
| These tests are designed to be 90% accurate at catching bugs on your |
There was a problem hiding this comment.
| These tests are designed to be 90% accurate at catching bugs on your | |
| These tests, based on historical data, are 90% accurate at detecting bugs on your |
|
|
||
| These tests are designed to be 90% accurate at catching bugs on your | ||
| PR while running only 10% of the full test suite. As a result, | ||
| microcheck typically finishes twice as fast and twice cheaper than |
There was a problem hiding this comment.
| microcheck typically finishes twice as fast and twice cheaper than | |
| microcheck typically runs twice as fast and costs half as much as |
| cases, and the PR will merge automatically once they finish and pass. | ||
|
|
||
| Alternatively, you can also add a `go` label to manually trigger the full | ||
| test suite on your PR (be mindful that this is less recommended but we |
There was a problem hiding this comment.
| test suite on your PR (be mindful that this is less recommended but we | |
| test suite on your PR. Be mindful of the cost and run time consequences of this option. |
|
|
||
| Alternatively, you can also add a `go` label to manually trigger the full | ||
| test suite on your PR (be mindful that this is less recommended but we | ||
| understand you know best about the need of your PR). While we anticipate |
There was a problem hiding this comment.
| understand you know best about the need of your PR). While we anticipate |
| Alternatively, you can also add a `go` label to manually trigger the full | ||
| test suite on your PR (be mindful that this is less recommended but we | ||
| understand you know best about the need of your PR). While we anticipate | ||
| this will be rarely needed, if you do require it constantly, please let |
There was a problem hiding this comment.
| this will be rarely needed, if you do require it constantly, please let | |
| You should only need to run the full suite in rare cases. However, if you require it frequently, |
| test suite on your PR (be mindful that this is less recommended but we | ||
| understand you know best about the need of your PR). While we anticipate | ||
| this will be rarely needed, if you do require it constantly, please let | ||
| us know. We are continuously improve the effectiveness of microcheck. |
There was a problem hiding this comment.
| us know. We are continuously improve the effectiveness of microcheck. | |
| let the Ray team know. The Ray team is continuously improving the effectiveness of microcheck. |
Co-authored-by: angelinalg <[email protected]> Signed-off-by: Cuong Nguyen <[email protected]> Signed-off-by: can <[email protected]>
As title, add a doc page about the new ci testing workflow (microcheck, go, premerge, etc.). I'll follow up with another PR to add more images to the doc.
Test: