|
1 | | -name: Deploy API Docs (Javadocs Only) |
2 | | - |
3 | | -on: |
4 | | - push: |
5 | | - branches: [main] |
6 | | - workflow_dispatch: |
7 | | - |
8 | | -jobs: |
9 | | - build-and-deploy: |
10 | | - runs-on: ubuntu-latest |
11 | | - steps: |
12 | | - - uses: actions/checkout@v4 |
13 | | - |
14 | | - - name: Set up JDK |
15 | | - uses: actions/setup-java@v4 |
16 | | - with: |
17 | | - distribution: temurin |
18 | | - java-version: "21" |
19 | | - |
20 | | - - name: Cache Maven repository |
21 | | - uses: actions/cache@v4 |
22 | | - with: |
23 | | - path: ~/.m2/repository |
24 | | - key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} |
25 | | - restore-keys: ${{ runner.os }}-m2- |
26 | | - |
27 | | - - name: Build Maven site (includes apidocs) |
28 | | - run: mvn -B -DskipTests site |
29 | | - |
30 | | - - name: Determine project version |
31 | | - id: get-version |
32 | | - run: echo "version=$(mvn -q -DforceStdout help:evaluate -Dexpression=project.version)" >> $GITHUB_OUTPUT |
33 | | - |
34 | | - - name: Prepare versioned Javadocs |
35 | | - run: | |
36 | | - mkdir -p build/site-workdir |
37 | | - cp -R target/site/apidocs build/site-workdir/apidocs-temp |
38 | | - chmod +x scripts/generate-javadoc-index.sh |
39 | | - scripts/generate-javadoc-index.sh --root build/site-workdir --version "${{ steps.get-version.outputs.version }}" --latest --project-url https://github.com/YOUR_USERNAME/YOUR_REPO_NAME --package com.digitizer.ui |
40 | | -
|
41 | | - - name: Deploy versioned Javadocs to GitHub Pages |
42 | | - uses: peaceiris/actions-gh-pages@v3 |
43 | | - with: |
44 | | - github_token: ${{ secrets.GITHUB_TOKEN }} |
45 | | - publish_dir: build/site-workdir |
46 | | - publish_branch: gh-pages |
47 | | - force_orphan: true |
48 | | - disable_nojekyll: true |
| 1 | +name: Deploy API Docs (Javadocs Only) |
| 2 | + |
| 3 | +on: |
| 4 | + push: |
| 5 | + branches: [main] |
| 6 | + workflow_dispatch: |
| 7 | + |
| 8 | +jobs: |
| 9 | + build-and-deploy: |
| 10 | + runs-on: ubuntu-latest |
| 11 | + steps: |
| 12 | + - uses: actions/checkout@v4 |
| 13 | + |
| 14 | + - name: Set up JDK |
| 15 | + uses: actions/setup-java@v4 |
| 16 | + with: |
| 17 | + distribution: temurin |
| 18 | + java-version: "21" |
| 19 | + |
| 20 | + - name: Cache Maven repository |
| 21 | + uses: actions/cache@v4 |
| 22 | + with: |
| 23 | + path: ~/.m2/repository |
| 24 | + key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} |
| 25 | + restore-keys: ${{ runner.os }}-m2- |
| 26 | + |
| 27 | + - name: Build Maven site and apidocs |
| 28 | + run: | |
| 29 | + mvn -B -ntp -DskipTests site |
| 30 | + # Ensure apidocs are present; if not, generate explicitly |
| 31 | + if [ ! -d target/site/apidocs ]; then |
| 32 | + echo "apidocs not found after 'mvn site'; generating explicitly via javadoc:javadoc" >&2 |
| 33 | + mvn -B -ntp -DskipTests javadoc:javadoc |
| 34 | + fi |
| 35 | + test -d target/site/apidocs || { echo "ERROR: target/site/apidocs still missing after generation" >&2; exit 1; } |
| 36 | +
|
| 37 | + - name: Determine project version |
| 38 | + id: get-version |
| 39 | + run: echo "version=$(mvn -q -DforceStdout help:evaluate -Dexpression=project.version)" >> $GITHUB_OUTPUT |
| 40 | + |
| 41 | + - name: Prepare versioned Javadocs |
| 42 | + run: | |
| 43 | + mkdir -p build/site-workdir |
| 44 | + cp -R target/site/apidocs build/site-workdir/apidocs-temp |
| 45 | + chmod +x scripts/generate-javadoc-index.sh |
| 46 | + scripts/generate-javadoc-index.sh \ |
| 47 | + --root build/site-workdir \ |
| 48 | + --version "${{ steps.get-version.outputs.version }}" \ |
| 49 | + --latest \ |
| 50 | + --project-url "https://github.com/${{ github.repository }}" \ |
| 51 | + --package com.digitizer.ui |
| 52 | +
|
| 53 | + - name: Deploy versioned Javadocs to GitHub Pages |
| 54 | + uses: peaceiris/actions-gh-pages@v3 |
| 55 | + with: |
| 56 | + github_token: ${{ secrets.GITHUB_TOKEN }} |
| 57 | + publish_dir: build/site-workdir |
| 58 | + publish_branch: gh-pages |
| 59 | + force_orphan: true |
| 60 | + disable_nojekyll: true |
0 commit comments