scratch-for-java/.github/workflows/docs.yml at main · openpatch/scratch-for-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
name: Documentation

on:
  push:
    branches:
      - main
  # Rebuild the docs by hand after a Hyperbook release, when no push to main
  # happened in between (see RELEASING.md).
  workflow_dispatch:

jobs:
  documentation:
    runs-on: ubuntu-latest
    timeout-minutes: 20

    permissions:
      pages: write      # needed to publish to GitHub Pages
      id-token: write   # required for GitHub Pages deployment

    steps:
      - name: Checkout repository
        uses: actions/checkout@v7

      - name: Set up Java
        uses: actions/setup-java@v5
        with:
          distribution: temurin
          java-version: 25
          cache: maven

      - name: Build Java Project
        run: mvn clean package

      - name: Check browser compatibility before publishing
        uses: ./.github/actions/check-browser

      - uses: actions/setup-node@v4
        with:
          node-version: '22'

      # always the newest Hyperbook, so the docs follow its releases
      - name: Install the latest Hyperbook toolchain
        run: npm install --global hyperbook@latest

      - name: Build Docs
        run:  bash ./build.sh

      # written by reference-docs.sh, which build.sh runs; on 7.0 no Maven build
      # step produces it any more (the javadoc jar lives in the central profile)
      - name: Copy Javadocs into docs
        run: cp -r target/apidocs ./docs/.hyperbook/out/javadocs

      - name: Setup Pages
        uses: actions/configure-pages@v6

      - name: Upload Docs artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: ./docs/.hyperbook/out

      - name: Deploy Javadocs to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5