41fd12d20a
Also speed up the external link check by avoiding checking each bug submission link in the rendered docs which only differs by its parameter. Closes #22200
100 lines
No EOL
2.9 KiB
YAML
100 lines
No EOL
2.9 KiB
YAML
name: Keycloak Documentation
|
|
|
|
on:
|
|
push:
|
|
branches-ignore:
|
|
- main
|
|
- dependabot/**
|
|
pull_request:
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
# Only cancel jobs for PR updates
|
|
group: documentation-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
|
|
jobs:
|
|
|
|
conditional:
|
|
name: Check conditional workflows and jobs
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
documentation: ${{ steps.conditional.outputs.documentation }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- id: conditional
|
|
uses: ./.github/actions/conditional
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
build:
|
|
name: Build
|
|
if: ${{ needs.conditional.outputs.documentation == 'true' }}
|
|
runs-on: ubuntu-latest
|
|
needs: conditional
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- id: setup-java
|
|
name: Setup Java
|
|
uses: ./.github/actions/java-setup
|
|
|
|
- id: maven-cache
|
|
name: Maven cache
|
|
uses: ./.github/actions/maven-cache
|
|
|
|
- id: build-test-documentation
|
|
name: Build and verify Keycloak documentation
|
|
shell: bash
|
|
run: |
|
|
MVN_HTTP_CONFIG="-Dhttp.keepAlive=false -Dmaven.wagon.http.pool=false -Dmaven.wagon.http.retryHandler.class=standard -Dmaven.wagon.http.retryHandler.count=3 -Dmaven.wagon.httpconnectionManager.ttlSeconds=120"
|
|
./mvnw install -Dtest=!ExternalLinksTest -am -pl docs/documentation/tests,docs/documentation/dist -nsu -B -e $MVN_HTTP_CONFIG -Pdocumentation
|
|
|
|
- id: upload-keycloak-documentation
|
|
name: Upload Keycloak documentation
|
|
uses: actions/upload-artifact@v3
|
|
with:
|
|
name: keycloak-documentation
|
|
path: docs/documentation/dist/target/*.zip
|
|
retention-days: 1
|
|
|
|
external-links:
|
|
name: External links check
|
|
if: ${{ needs.conditional.outputs.documentation == 'true' }}
|
|
runs-on: ubuntu-latest
|
|
needs: conditional
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- id: setup-java
|
|
name: Setup Java
|
|
uses: ./.github/actions/java-setup
|
|
|
|
- id: maven-cache
|
|
name: Maven cache
|
|
uses: ./.github/actions/maven-cache
|
|
|
|
- id: build-test-documentation
|
|
name: Build and verify Keycloak documentation
|
|
shell: bash
|
|
run: |
|
|
MVN_HTTP_CONFIG="-Dhttp.keepAlive=false -Dmaven.wagon.http.pool=false -Dmaven.wagon.http.retryHandler.class=standard -Dmaven.wagon.http.retryHandler.count=3 -Dmaven.wagon.httpconnectionManager.ttlSeconds=120"
|
|
./mvnw install -Dtest=ExternalLinksTest -am -pl docs/documentation/tests -nsu -B -e -Pdocumentation $MVN_HTTP_CONFIG
|
|
|
|
check:
|
|
name: Status Check - Keycloak Documentation
|
|
if: always()
|
|
needs:
|
|
- conditional
|
|
- build
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: ./.github/actions/status-check
|
|
with:
|
|
jobs: ${{ toJSON(needs) }} |