Skip to content

build: bump mkdocs-material from 9.5.29 to 9.5.30 in /.github/workflows #186

build: bump mkdocs-material from 9.5.29 to 9.5.30 in /.github/workflows

build: bump mkdocs-material from 9.5.29 to 9.5.30 in /.github/workflows #186

Workflow file for this run

name: CI
on:
- pull_request
- push
- workflow_dispatch
env:
JDK_VERSION: "21"
WORKSPACE_ARCHIVE: workspace.tar
WORKSPACE_ARTIFACT: build-results
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Validate Gradle wrapper
uses: gradle/actions/wrapper-validation@v3
- name: Setup Java
uses: actions/setup-java@v4
with:
distribution: "temurin"
java-version: ${{ env.JDK_VERSION }}
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3
with:
gradle-home-cache-cleanup: true
- name: Gradle Assemble
run: ./gradlew assemble --info -S --show-version
- name: Tar files
run: tar --exclude='.git' --exclude=${{ env.WORKSPACE_ARCHIVE }} -cvf ${{ env.WORKSPACE_ARCHIVE }} .
- name: Upload workspace artifact
uses: actions/upload-artifact@v4
with:
name: ${{ env.WORKSPACE_ARTIFACT }}
path: ${{ env.WORKSPACE_ARCHIVE }}
retention-days: 1
build-docs:
name: Build Documentation
needs: build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/download-artifact@v4
with:
name: ${{ env.WORKSPACE_ARTIFACT }}
path: .
- name: Untar
run: |
tar -xvf ${{ env.WORKSPACE_ARCHIVE }}
rm ${{ env.WORKSPACE_ARCHIVE }}
- name: Setup Python
uses: actions/setup-python@v5
- name: Install dependencies
run: pip3 install --no-deps -r .github/workflows/mkdocs-requirements.txt
- name: MkDocs Build
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./build/site
retention-days: 3
check:
name: Check
strategy:
matrix:
jdk: [ 22 ]
needs: build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/download-artifact@v4
with:
name: ${{ env.WORKSPACE_ARTIFACT }}
path: .
- name: Untar
run: |
tar -xvf ${{ env.WORKSPACE_ARCHIVE }}
rm ${{ env.WORKSPACE_ARCHIVE }}
- name: Setup Java
uses: actions/setup-java@v4
with:
distribution: "temurin"
java-version: ${{ env.JDK_VERSION }}
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3
with:
gradle-home-cache-cleanup: true
- name: Gradle Check
run: ./gradlew check --info -S --show-version -Ptoolchain.test.version=${{ matrix.jdk }}
# So, what's happening here?
#
# Basically, restoring the workspace state between jobs is incredibly annoying.
# We can get reasonable support by using the upload-/download-artifact
# actions, but they suffer from a severe limitation:
# GH Actions has a storage limit and the minimum retention is 24 hours...
#
# Since the storage quota is limited, we have to make sure that the artifact
# is removed. Unfortunately, there is no official way to do this, so we resort
# to a third party action for now.
#
# See also: https://github.com/actions/upload-artifact/issues/290
cleanup:
name: Cleanup
if: ${{ always() }}
needs: [build-docs, check]
runs-on: ubuntu-latest
permissions:
actions: write
steps:
- name: Cleanup
uses: GeekyEggo/delete-artifact@24928e75e6e6590170563b8ddae9fac674508aa1
with:
name: ${{ env.WORKSPACE_ARTIFACT }}