From e4823e3c32b556a54ad14705a7a4fc17b5ae65f5 Mon Sep 17 00:00:00 2001 From: "Wendland, Florian" Date: Fri, 16 Feb 2024 09:12:46 +0100 Subject: [PATCH 1/2] Fix run command for docs workflow --- .github/workflows/docs.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 21e2016bd..6036b4f1d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -26,9 +26,8 @@ jobs: uses: gradle/actions/setup-gradle@v3 - name: 'Build API pages' run: | - ./gradlew - dokkaHtmlMultiModule - -Dorg.gradle.internal.repository.max.tentatives=5 - -Dorg.gradle.internal.repository.initial.backoff=10000 + ./gradlew dokkaHtmlMultiModule \ + -Dorg.gradle.internal.repository.max.tentatives=5 \ + -Dorg.gradle.internal.repository.initial.backoff=10000 - name: 'Build & deploy docs' run: mkdocs gh-deploy --force From 111595568c676f0036403f191c12c80bede36ce2 Mon Sep 17 00:00:00 2001 From: "Wendland, Florian" Date: Mon, 4 Mar 2024 13:51:52 +0100 Subject: [PATCH 2/2] Add `setup-java` to ensure Java for Gradle and use `setup-python`'s cache --- .github/workflows/docs.yml | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6036b4f1d..bf2f96fbc 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -11,23 +11,26 @@ jobs: contents: write steps: - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.x' - - uses: actions/cache@v4 + # Ensure Java installation to run Gradle + - uses: actions/setup-java@v4 with: - key: ${{ github.ref }} - path: .cache - - name: 'Install mkdocs-material and plugins' - run: | - python -m pip install mkdocs-material - python -m pip install -r ./docs/mkdocs-material-plugins.txt - - name: Setup Gradle + distribution: "temurin" + java-version: 17 + - name: 'Setup Gradle' uses: gradle/actions/setup-gradle@v3 - name: 'Build API pages' run: | ./gradlew dokkaHtmlMultiModule \ -Dorg.gradle.internal.repository.max.tentatives=5 \ -Dorg.gradle.internal.repository.initial.backoff=10000 + - uses: actions/setup-python@v5 + with: + python-version: '3.x' + cache: 'pip' + cache-dependency-path: './docs/mkdocs-material-plugins.txt' + - name: 'Install mkdocs-material and plugins' + run: | + python -m pip install mkdocs-material + python -m pip install -r ./docs/mkdocs-material-plugins.txt - name: 'Build & deploy docs' run: mkdocs gh-deploy --force