You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gluten.apache.org by yu...@apache.org on 2024/10/14 02:01:54 UTC

(incubator-gluten) branch main updated: [GLUTEN-7496][DOCS] Add View the Surefire reports of velox test in NewToGluten.md (#7501)

This is an automated email from the ASF dual-hosted git repository.

yuanzhou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git


The following commit(s) were added to refs/heads/main by this push:
     new 8c714860f2 [GLUTEN-7496][DOCS] Add View the Surefire reports of velox test in NewToGluten.md (#7501)
8c714860f2 is described below

commit 8c714860f27c1603fab5dcbb1a216f3acf1eff6c
Author: Qian Sun <qi...@gmail.com>
AuthorDate: Mon Oct 14 10:01:50 2024 +0800

    [GLUTEN-7496][DOCS] Add View the Surefire reports of velox test in NewToGluten.md (#7501)
    
    Add View the Surefire reports of velox test in NewToGluten.md
    
    (Fixes: #7496)
---
 docs/developers/NewToGluten.md |  19 +++++++++++++++++++
 docs/image/surefire-report.png | Bin 0 -> 2619871 bytes
 2 files changed, 19 insertions(+)

diff --git a/docs/developers/NewToGluten.md b/docs/developers/NewToGluten.md
index 0d73d4155f..8228c919e8 100644
--- a/docs/developers/NewToGluten.md
+++ b/docs/developers/NewToGluten.md
@@ -323,6 +323,25 @@ After the above installation, you can optionally do some configuration in Visual
 4. Placement of Non-Native Code UTs: Ensure that unit tests for non-native code are placed within org.apache.gluten and org.apache.spark packages. 
    This is important because the CI system runs unit tests from these two paths in parallel. Placing tests in other paths might cause your tests to be ignored.
 
+### View surefire reports of velox ut in GHA  
+
+Surefire reports are invaluable tools in the ecosystem of Java-based applications that utilize the Maven build automation tool.  
+These reports are generated by the Maven Surefire Plugin during the testing phase of your build process.  
+They compile results from unit tests, providing detailed insights into which tests passed or failed, what errors were encountered, and other essential metrics.  
+
+Surefire reports play a crucial role in the development and maintenance of high-quality software.  
+We provide surefire reports of velox ut in GHA, and developers can leverage surefire reports with early bug detection and quality assurance.  
+
+You can check surefire reports:
+
+1. Click `Checks` Tab in PR;  
+
+2. Find `Report test results` in `Dev PR`;
+
+3. Then, developers can check the result with summary and annotations.  
+
+![](../image/surefire-report.png)  
+
 # Debug cpp code with coredump
 
 ```bash
diff --git a/docs/image/surefire-report.png b/docs/image/surefire-report.png
new file mode 100644
index 0000000000..8b4ca6c713
Binary files /dev/null and b/docs/image/surefire-report.png differ


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@gluten.apache.org
For additional commands, e-mail: commits-help@gluten.apache.org