Keycloak

1
name: Keycloak Documentation
2

3
on:
4
  push:
5
    branches-ignore:
6
      - main
7
      - dependabot/**
8
      - quarkus-next
9
  pull_request:
10
  workflow_dispatch:
11

12
env:
13
  MAVEN_ARGS: "-B -nsu -Daether.connector.http.connectionMaxTtl=25"
14

15
concurrency:
16
  # Only cancel jobs for PR updates
17
  group: documentation-${{ github.ref }}
18
  cancel-in-progress: true
19

20
defaults:
21
  run:
22
    shell: bash
23

24
jobs:
25

26
  conditional:
27
    name: Check conditional workflows and jobs
28
    runs-on: ubuntu-latest
29
    outputs:
30
      documentation: ${{ steps.conditional.outputs.documentation }}
31
    steps:
32
      - uses: actions/checkout@v4
33

34
      - id: conditional
35
        uses: ./.github/actions/conditional
36
        with:
37
          token: ${{ secrets.GITHUB_TOKEN }}
38

39
  build:
40
    name: Build
41
    if: ${{ needs.conditional.outputs.documentation == 'true' }}
42
    runs-on: ubuntu-latest
43
    needs: conditional
44
    steps:
45
      - uses: actions/checkout@v4
46

47
      - id: setup-java
48
        name: Setup Java
49
        uses: ./.github/actions/java-setup
50

51
      - id: maven-cache
52
        name: Maven cache
53
        uses: ./.github/actions/maven-cache
54

55
      - id: build-test-documentation
56
        name: Build and verify Keycloak documentation
57
        shell: bash
58
        run: |
59
          ./mvnw install -Dtest=!ExternalLinksTest -am -pl docs/documentation/tests,docs/documentation/dist -e -Pdocumentation
60

61
      - id: upload-keycloak-documentation
62
        name: Upload Keycloak documentation
63
        uses: actions/upload-artifact@v3
64
        with:
65
          name: keycloak-documentation
66
          path: docs/documentation/dist/target/*.zip
67
          retention-days: 1
68

69
  external-links:
70
    name: External links check
71
    if: ${{ needs.conditional.outputs.documentation == 'true' }}
72
    runs-on: ubuntu-latest
73
    needs: conditional
74
    steps:
75
      - uses: actions/checkout@v4
76

77
      - id: setup-java
78
        name: Setup Java
79
        uses: ./.github/actions/java-setup
80

81
      - id: maven-cache
82
        name: Maven cache
83
        uses: ./.github/actions/maven-cache
84

85
      - id: build-test-documentation
86
        name: Build and verify Keycloak documentation
87
        shell: bash
88
        run: |
89
          ./mvnw install -Dtest=ExternalLinksTest -am -pl docs/documentation/tests -e -Pdocumentation 
90

91
  check:
92
    name: Status Check - Keycloak Documentation
93
    if: always()
94
    needs:
95
      - conditional
96
      - build
97
    runs-on: ubuntu-latest
98
    steps:
99
      - uses: actions/checkout@v4
100
      - uses: ./.github/actions/status-check
101
        with:
102
          jobs: ${{ toJSON(needs) }}