Processing-Library-Plugin/.github/workflows/docs.yml at main · Stephcraft/Processing-Library-Plugin · 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
# Repository → Settings → Pages
# Source = GitHub Actions
# https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax

name: Deploy Dokka Docs

on:
  push:
    branches:
      - main
    paths-ignore:
      - README.md
      - processing-library-example

# https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#permissions
permissions:
  contents: read
  pages: write
  # GITHUB_TOKEN for actions/deploy-pages
  # https://docs.github.com/en/actions/concepts/security/openid-connect
  id-token: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:

        # Download repository
        # https://github.com/actions/checkout
      - name: Checkout
        uses: actions/checkout@v7

        # Install Java
        # https://github.com/actions/setup-java
      - name: Setup JDK
        uses: actions/setup-java@v5
        with:
          distribution: temurin
          java-version: 17

        # Setup Gradle
        # https://github.com/gradle/actions/tree/main/setup-gradle
      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@v6
        with:
          gradle-version: '9.5.0'

      - name: Generate Dokka
        run: gradle dokkaGenerate

        # Upload to GitHub pages
        # https://github.com/actions/upload-pages-artifact
      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: build/dokka/html
        # https://github.com/actions/deploy-pages
      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@v5