You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ti...@apache.org on 2023/08/15 23:57:14 UTC

[curator-site] branch javadoc created (now 0457ddf)

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

tison pushed a change to branch javadoc
in repository https://gitbox.apache.org/repos/asf/curator-site.git


      at 0457ddf  feat: generate javadoc

This branch includes the following new commits:

     new 0457ddf  feat: generate javadoc

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[curator-site] 01/01: feat: generate javadoc

Posted by ti...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

tison pushed a commit to branch javadoc
in repository https://gitbox.apache.org/repos/asf/curator-site.git

commit 0457ddfd23574050854e9565a12817bd814d1ba1
Author: tison <wa...@gmail.com>
AuthorDate: Wed Aug 16 07:57:01 2023 +0800

    feat: generate javadoc
    
    Signed-off-by: tison <wa...@gmail.com>
---
 .github/workflows/deploy.yml | 24 ++++++++++++++++++++++++
 sidebars.js                  |  1 +
 2 files changed, 25 insertions(+)

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index 0521e78..56aeb65 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -24,10 +24,34 @@ on:
   pull_request:
 
 jobs:
+  build-javadoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: 'apache/curator'
+      - uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: '17'
+      - name: Build javadoc
+        run: mvn javadoc:aggregate
+      - name: Upload javadoc
+        uses: actions/upload-artifact@v3
+        with:
+          name: javadoc
+          path: ./target/site/apidocs
+
   deploy:
     runs-on: ubuntu-latest
+    needs: [build-javadoc]
     steps:
       - uses: actions/checkout@v3
+      - name: Download javadoc
+        uses: actions/download-artifact@v3
+        with:
+          name: javadoc
+          path: ./static/apidocs
       - uses: actions/setup-node@v3
         with:
           node-version: 19.x
diff --git a/sidebars.js b/sidebars.js
index dabc210..0c03d3a 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -74,6 +74,7 @@ const sidebars = {
         },
         'zk-compatibility-34',
         'breaking-changes',
+        {type: 'link', label: 'Javadoc', href: '/apidocs/'},
         {type: 'link', label: 'Wiki', href: 'https://cwiki.apache.org/confluence/display/CURATOR'},
         {type: 'html', defaultStyle: true, value: 'EXTENSIONS'},
         'service-discovery',