Skip to content

Bump rexml from 3.2.5 to 3.2.8 in /projects/opd-and-delius/tech-docs #1455

Bump rexml from 3.2.5 to 3.2.8 in /projects/opd-and-delius/tech-docs

Bump rexml from 3.2.5 to 3.2.8 in /projects/opd-and-delius/tech-docs #1455

Workflow file for this run

name: Documentation
on:
push:
paths:
- .github/workflows/docs.yml
- projects/**/tech-docs/**
- doc/tech-docs/**
schedule:
- cron: "30 5 * * MON-FRI" # Every weekday at 05:30 UTC
workflow_dispatch:
inputs:
deploy:
description: Deploy?
type: boolean
jobs:
get-projects:
runs-on: ubuntu-latest
outputs:
projects: ${{ steps.output.outputs.projects }}
steps:
- uses: actions/checkout@v4
- id: output
run: echo "projects=$(cd projects && find . -name tech-docs -exec dirname {} \; | sed 's#^\./##' | jq --raw-input . | jq --slurp --compact-output .)" | tee -a "$GITHUB_OUTPUT"
build-index:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
bundler-cache: true
working-directory: doc/tech-docs
- name: Build
run: |
gem install middleman
bundle exec middleman build --verbose
working-directory: doc/tech-docs
- uses: actions/upload-artifact@v4
with:
name: index
path: doc/tech-docs/build
build-projects:
runs-on: ubuntu-latest
timeout-minutes: 30
needs: get-projects
strategy:
fail-fast: false
matrix:
project: ${{ fromJson(needs.get-projects.outputs.projects) }}
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
bundler-cache: true
working-directory: projects/${{ matrix.project }}/tech-docs
- name: Check if OpenAPI is configured
id: check_config
run: echo "api_path=$(yq '.api_path' 'projects/${{ matrix.project }}/tech-docs/config/tech-docs.yml')" | tee -a "$GITHUB_OUTPUT"
- uses: actions/setup-java@v4
if: startsWith(steps.check_config.outputs.api_path, 'http')
with:
java-version: '21'
distribution: 'temurin'
- uses: gradle/actions/setup-gradle@v3
if: startsWith(steps.check_config.outputs.api_path, 'http')
with:
cache-read-only: true
- name: Host OpenAPI spec
if: startsWith(steps.check_config.outputs.api_path, 'http')
run: |
./gradlew '${{ matrix.project }}:bootRun' &
timeout 300 sh -c 'until curl -s localhost:8080/v3/api-docs.yaml; do sleep 5; done'
yq -i '.api_path = "http://localhost:8080/v3/api-docs.yaml"' 'projects/${{ matrix.project }}/tech-docs/config/tech-docs.yml'
env:
SPRING_PROFILES_ACTIVE: dev
- name: Set branch
if: github.ref_name != 'main'
run: sed -i "s|$REPOSITORY/main|$REPOSITORY/$BRANCH|" index.html.md.erb
working-directory: projects/${{ matrix.project }}/tech-docs/source
env:
REPOSITORY: ${{ github.repository }}
BRANCH: ${{ github.ref_name }}
- name: Build
run: |
gem install middleman
bundle exec middleman build --verbose
working-directory: projects/${{ matrix.project }}/tech-docs
- name: Bundle API specs
if: startsWith(steps.check_config.outputs.api_path, 'http')
run: |
curl -sf localhost:8080/v3/api-docs -o api-docs.json
curl -sf localhost:8080/v3/api-docs.yaml -o api-docs.yaml
working-directory: projects/${{ matrix.project }}/tech-docs/build
- uses: actions/upload-artifact@v4
with:
name: ${{ matrix.project }}
path: projects/${{ matrix.project }}/tech-docs/build
deploy:
runs-on: ubuntu-latest
timeout-minutes: 30
if: github.ref_name == 'main' || (github.event_name == 'workflow_dispatch' && inputs.deploy)
needs:
- build-index
- build-projects
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
path: artifacts
- name: Merge artifacts
run: |
mv artifacts/index/ tech-docs
mkdir -p tech-docs/projects
find artifacts -mindepth 1 -maxdepth 1 -print0 | xargs -0 -L1 basename | xargs -I{} mv 'artifacts/{}' 'tech-docs/projects/{}/'
- name: Deploy main
if: github.ref_name == 'main'
uses: JamesIves/github-pages-deploy-action@5c6e9e9f3672ce8fd37b9856193d2a537941e66c # v4.6.1
with:
folder: tech-docs
target-folder: tech-docs
- name: Deploy branch
if: github.ref_name != 'main'
uses: JamesIves/github-pages-deploy-action@5c6e9e9f3672ce8fd37b9856193d2a537941e66c # v4.6.1
with:
folder: tech-docs
target-folder: tech-docs-drafts/${{ github.ref_name }}