Skip to content

Commit 5dbd0b0

Browse files
committed
JVMCBC-1659 GHA: Automate publishing API reference documentation
Modifications ------------- Upgrade maven-javadoc-plugin from 3.4.1 to 3.11.2. NOTE: This changes the output directory from `target/apidocs` to target/report/apidocs` for java-client, core-io, and columnar-java-client. Add an API doc publishing step to the "release" workflow. Change-Id: Ibcc71243443dd8e3638bc9923c7d472851bd0d9a Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/229307 Reviewed-by: Graham Pople <[email protected]> Tested-by: Build Bot <[email protected]>
1 parent 1911f1f commit 5dbd0b0

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

.github/workflows/deploy-release.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,19 @@ jobs:
3939
MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
4040
MAVEN_GPG_KEY: ${{ secrets.SDK_ROBOT_GPG_PRIVATE_KEY }}
4141
MAVEN_GPG_PASSPHRASE: ''
42+
43+
- uses: aws-actions/configure-aws-credentials@v3
44+
with:
45+
role-to-assume: arn:aws:iam::786014483886:role/SDK_GHA
46+
aws-region: us-west-1
47+
48+
- name: Upload API documentation
49+
run: |
50+
function upload() {
51+
aws s3 cp --recursive --acl public-read $1/$2 s3://docs.couchbase.com/sdk-api/couchbase-$1-${{ inputs.tag }}
52+
}
53+
upload "core-io" "target/reports/apidocs"
54+
upload "java-client" "target/reports/apidocs"
55+
upload "scala-client" "target/site/scaladocs"
56+
upload "kotlin-client" "target/dokka"
57+
upload "columnar-java-client" "target/reports/apidocs"

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
<maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
5252
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
53-
<maven-javadoc-plugin.version>3.4.1</maven-javadoc-plugin.version>
53+
<maven-javadoc-plugin.version>3.11.2</maven-javadoc-plugin.version>
5454
<build-helper-maven-plugin.version>3.2.0</build-helper-maven-plugin.version>
5555
<flatten-maven-plugin.version>1.7.0</flatten-maven-plugin.version>
5656
<scala-maven-plugin.version>4.8.1</scala-maven-plugin.version>

0 commit comments

Comments
 (0)