You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@orc.apache.org by wi...@apache.org on 2021/08/16 00:07:08 UTC

[orc] branch main updated: ORC-955: Add Javadoc generation GitHub Action job (#868)

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

william pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/orc.git


The following commit(s) were added to refs/heads/main by this push:
     new ee3fe61  ORC-955: Add Javadoc generation GitHub Action job (#868)
ee3fe61 is described below

commit ee3fe61affd31860f78138c757a9fa44769ebc8a
Author: Dongjoon Hyun <do...@apache.org>
AuthorDate: Sun Aug 15 17:07:03 2021 -0700

    ORC-955: Add Javadoc generation GitHub Action job (#868)
    
    ### What changes were proposed in this pull request?
    
    This PR aims to add a `javadoc` generation test coverage to prevent a future regression.
    
    ### Why are the changes needed?
    
    Although Javadoc generation is a non-functional step, we had better remove the possibility of VOTE failure completely.
    
    ### How was this patch tested?
    
    Pass the GitHub Action with the new job.
---
 .github/workflows/build_and_test.yml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
index 61d703c..c4ce4fa 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -52,3 +52,20 @@ jobs:
           cmake -DANALYZE_JAVA=ON -DOPENSSL_ROOT_DIR=`brew --prefix openssl` ..
         fi
         make package test-out
+
+  doc:
+    name: "Javadoc generation"
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Java 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: "javadoc"
+      run: |
+        mkdir -p ~/.m2
+        cd java
+        mvn install -DskipTests
+        mvn javadoc:javadoc