From f0e259595fdf17d47a2614b83484add66d750cbf Mon Sep 17 00:00:00 2001 From: Peixin Li Date: Tue, 27 Jul 2021 11:12:27 +0800 Subject: [PATCH] add doc for PR status checks --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e8203093726..462b77b2bdfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -187,5 +187,18 @@ You can confirm that the update actually has happened by either inspecting its e `git diff` first or simply reexecuting `git commit` right away. The second time no file modification should be triggered by the copyright year update hook and the commit should succeed. +### Pull request status checks +A pull request should pass all status checks before merged. +#### signoff check +Please follow [sign-your-work](#sign-your-work) section, and make sure at least one commit in your pull request get signed-off. +#### blossom-ci +The check runs on NVIDIA self-hosted runner, a [project committer](.github/workflows/blossom-ci.yml#L36) can manually trigger it by commenting `build`. It includes following steps, +1. Mergeable check +2. Blackduck vulnerability check +3. Fetch merged code (merge the pull request HEAD into BASE branch, e.g. fea-001 into branch-x) +4. Run `mvn verify` and unit tests for multiple spark versions in parallel. Ref: [spark-premerge-build.sh](jenkins/spark-premerge-build.sh) + +If fail, you can click the `Details` link of this check, and go to `Post processing -> Start post processing` to find the uploaded log. + ## Attribution Portions adopted from https://github.com/rapidsai/cudf/blob/main/CONTRIBUTING.md, https://github.com/NVIDIA/nvidia-docker/blob/main/CONTRIBUTING.md, and https://github.com/NVIDIA/DALI/blob/main/CONTRIBUTING.md