OpenMapView/.github/workflows/_docs.yml at main · afarber/OpenMapView · 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:
  workflow_call:

permissions:
  contents: read

jobs:
  docs:
    name: Build Documentation
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 17

      - name: Cache Gradle
        uses: actions/cache@v4
        with:
          path: |
            ~/.gradle/caches
            ~/.gradle/wrapper
          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
          restore-keys: |
            ${{ runner.os }}-gradle-

      - name: Grant execute permission for Gradle wrapper
        run: chmod +x gradlew

      - name: Build documentation
        run: ./gradlew dokkaGenerate --no-daemon

      - name: Generate License Report
        run: ./gradlew generateLicenseReport --no-daemon

      - name: Copy License Report to Docs
        run: |
          mkdir -p openmapview/build/dokka/html/licenses
          cp openmapview/build/reports/licenses/licenses.html openmapview/build/dokka/html/licenses/index.html

      - name: Run Detekt Analysis
        run: ./gradlew detekt --no-daemon

      - name: Copy Detekt Report to Docs
        run: |
          mkdir -p openmapview/build/dokka/html/detekt
          cp openmapview/build/reports/detekt/detekt.html openmapview/build/dokka/html/detekt/index.html

      - name: Upload documentation artifact
        uses: actions/upload-artifact@v4
        with:
          name: documentation
          path: 'openmapview/build/dokka/html/**'
          retention-days: 30