From 59a94a3136a5f4f40ab5a671b62a42946d0e202a Mon Sep 17 00:00:00 2001 From: Frank Chen Date: Fri, 19 Jun 2026 10:27:33 -0700 Subject: [PATCH] chore: move javadoc to Github Action based Github Pages --- .github/workflows/build.yml | 42 ++++++++++++++++++++++++++++++------- README.md | 1 + 2 files changed, 36 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 72643a90e..b04f534d1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -19,6 +19,7 @@ on: branches: - main paths: + - '.github/workflows/build.yml' - 'sdk/**' - 'sdk-testing/**' - 'sdk-integration-tests/**' @@ -28,6 +29,7 @@ on: branches: - main paths: + - '.github/workflows/build.yml' - 'sdk/**' - 'sdk-testing/**' - 'sdk-integration-tests/**' @@ -36,6 +38,8 @@ on: permissions: contents: write + pages: write + id-token: write jobs: build: @@ -76,12 +80,36 @@ jobs: folder: coverage-report/target/site/jacoco-aggregate target-folder: coverage - - name: Deploy javadoc to Github Pages + - name: Generate javadoc site if: ${{ github.ref == 'refs/heads/main' && matrix.java == 17 }} - uses: MathieuSoysal/Javadoc-publisher.yml@fda475b197081ba1eca7a1dfadf0c017080a1623 # v3.0.2 + run: mvn -B -pl sdk -am javadoc:javadoc + + - name: Configure GitHub Pages + if: ${{ github.ref == 'refs/heads/main' && matrix.java == 17 }} + uses: actions/configure-pages@v5 + + - name: Prepare GitHub Pages artifact + if: ${{ github.ref == 'refs/heads/main' && matrix.java == 17 }} + run: | + mkdir -p github-pages/coverage github-pages/javadoc + cp -R coverage-report/target/site/jacoco-aggregate/. github-pages/coverage + cp -R sdk/target/site/apidocs/. github-pages/javadoc + touch github-pages/.nojekyll + + - name: Upload GitHub Pages artifact + if: ${{ github.ref == 'refs/heads/main' && matrix.java == 17 }} + uses: actions/upload-pages-artifact@v4 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - javadoc-branch: docs - target-folder: javadoc - java-version: 17 - project: maven + path: github-pages + + deploy-pages: + if: ${{ github.ref == 'refs/heads/main' }} + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 99a7614c7..f664b63a7 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ See [Deploy Lambda durable functions with Infrastructure as Code](https://docs.a - [AWS Documentation](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html) – Official AWS Lambda durable functions guide - [Best Practices](https://docs.aws.amazon.com/lambda/latest/dg/durable-best-practices.html) – Patterns and recommendations +- [Javadoc](https://aws.github.io/aws-durable-execution-sdk-java/javadoc/) - API reference for the Java SDK - [SDK Design](docs/design.md) – Details of SDK internal architecture **Core Operations**