From 344da0f720d6aa436b2ea47e340dcde80cb43ff9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20St=C3=A4ber?= Date: Sat, 16 Sep 2023 20:55:33 +0200 Subject: [PATCH] Add Github action to publish docs to Github pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabian Stäber --- .github/workflows/github-pages.yaml | 97 +++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 .github/workflows/github-pages.yaml diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml new file mode 100644 index 000000000..5e954389b --- /dev/null +++ b/.github/workflows/github-pages.yaml @@ -0,0 +1,97 @@ +name: Deploy Documentation to Github Pages + +on: + # Runs on pushes targeting the 1.0.x branch + push: + branches: + - 1.0.x + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +# Default to bash +defaults: + run: + shell: bash + +jobs: + # Build job + build: + runs-on: ubuntu-latest + env: + HUGO_VERSION: 0.115.4 + steps: + - name: Install OpenJDK 17 + run: sudo apt-get -q install -y openjdk-17-jdk + - name: Make 17 the default java version + run: sudo update-alternatives --set java /usr/lib/jvm/java-17-openjdk-amd64/bin/java + - name: Make 17 the default javadoc version + run: sudo update-alternatives --set java /usr/lib/jvm/java-17-openjdk-amd64/bin/java + - name: Print java and javadoc versions + run: | + echo java version && \ + java --version && \ + echo javadoc version && \ + javadoc --version + - name: Install Hugo CLI + run: | + wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \ + && sudo dpkg -i ${{ runner.temp }}/hugo.deb + - name: Install Dart Sass + run: sudo snap install dart-sass + - name: Checkout + uses: actions/checkout@v3 + with: + submodules: recursive + fetch-depth: 0 + - name: Build client_java + run: ./mvnw -B clean install -DskipTests + - name: Make Javadoc + run: ./mvnw -B compile javadoc:javadoc javadoc:aggregate + - name: Move the Javadoc to docs/static/api/ + run: mv ./target/site/apidocs ./docs/static/api + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Install Node.js dependencies + run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" + working-directory: ./docs + - name: Build with Hugo + env: + # For maximum backward compatibility with Hugo modules + HUGO_ENVIRONMENT: production + HUGO_ENV: production + run: | + hugo \ + --gc \ + --minify \ + --baseURL "${{ steps.pages.outputs.base_url }}/" + working-directory: ./docs + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: ./public + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2