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/16 00:13:32 UTC
[curator-site] branch main updated: feat: generate javadoc (#1)
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/curator-site.git
The following commit(s) were added to refs/heads/main by this push:
new 26ca411 feat: generate javadoc (#1)
26ca411 is described below
commit 26ca4115c8968f8ab1fd48ceb84b41d72d1123c0
Author: tison <wa...@gmail.com>
AuthorDate: Wed Aug 16 08:13:27 2023 +0800
feat: generate javadoc (#1)
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',