.github/workflows/publish-website.yaml
author Da Risk <da_risk@geekorum.com>
Mon, 05 May 2025 12:48:39 -0400
changeset 82 8a915338c80d
parent 78 9cf28ee2a8e9
permissions -rw-r--r--
ui:material2: add more kdocs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
76
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
# .github/workflows/publish.yml
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
name: Publish website
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
on:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
  workflow_dispatch:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
  release:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
    types: [released, prereleased]
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
jobs:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
  build-doc:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
    name: Build doc
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
    runs-on: macOS-latest
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
    steps:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
      - name: Check out code
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
        uses: actions/checkout@v4
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
      - name: Set up JDK 21
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
        uses: actions/setup-java@v4
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
        with:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
          distribution: 'zulu'
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
          java-version: 21
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
      - name: Setup Gradle
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
        uses: gradle/actions/setup-gradle@v4
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
      - name: Build api doc
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    24
        run: ./gradlew :dokka:dokkaGenerate
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    25
      - name: Setup python
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
        uses: actions/setup-python@v5
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
        with:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
          python-version: 3.x
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
      - run: pip install mkdocs-material
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
      - name: Build site
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
        run: mkdocs build
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    32
      - name: Upload artifact
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    33
        uses: actions/upload-pages-artifact@v3
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    34
        with:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
          path: site
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    37
  publish-doc:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    38
    environment:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    39
      name: github-pages
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    40
      url: ${{ steps.deployment.outputs.page_url }}
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    41
    runs-on: ubuntu-latest
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
    needs: build-doc
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
    permissions:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    44
      pages: write      # to deploy to Pages
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    45
      id-token: write   # to verify the deployment originates from an appropriate source
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    46
    steps:
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    47
      - name: Deploy to GitHub Pages
f71bc296e23d build: add workflow to publish-website
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    48
        id: deployment
78
9cf28ee2a8e9 merge workflows into main
Da Risk <da_risk@geekorum.com>
parents: 77 76
diff changeset
    49
        uses: actions/deploy-pages@v4