generated from ministryofjustice/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 0
176 lines (155 loc) · 6.03 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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 or AsyncAPI is configured
id: check_config
run: |
echo "has_rest_api=$(yq '. | has("api_path")' 'projects/${{ matrix.project }}/tech-docs/config/tech-docs.yml')" | tee -a "$GITHUB_OUTPUT"
echo "has_async_api=$(test -f 'projects/${{ matrix.project }}/tech-docs/source/asyncapi-reference.html.md.erb' && echo 'true' || echo 'false')" | tee -a "$GITHUB_OUTPUT"
- uses: actions/setup-java@v4
if: steps.check_config.outputs.has_rest_api == 'true' || steps.check_config.outputs.has_async_api == 'true'
with:
java-version: '21'
distribution: 'temurin'
- uses: gradle/actions/setup-gradle@v4
if: steps.check_config.outputs.has_rest_api || steps.check_config.outputs.has_async_api
with:
cache-read-only: true
- name: Host API specs
if: steps.check_config.outputs.has_rest_api == 'true' || steps.check_config.outputs.has_async_api == 'true'
run: |
./gradlew '${{ matrix.project }}:bootRun' &
timeout 300 sh -c 'until curl -s localhost:8080/v3/api-docs.yaml; do sleep 5; done'
env:
SPRING_PROFILES_ACTIVE: dev
- name: Update configured OpenAPI path
if: steps.check_config.outputs.has_rest_api == 'true'
run: yq -i '.api_path = "http://localhost:8080/v3/api-docs.yaml"' 'projects/${{ matrix.project }}/tech-docs/config/tech-docs.yml'
- name: Set branch in index
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: Set branch in asyncapi-reference
if: github.ref_name != 'main' && steps.check_config.outputs.has_async_api == 'true'
run: sed -i "s|/tech-docs/|/tech-docs-drafts/$BRANCH/|" asyncapi-reference.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 OpenAPI specs
if: steps.check_config.outputs.has_rest_api == 'true'
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
- name: Bundle AsyncAPI specs
if: steps.check_config.outputs.has_async_api == 'true'
run: |
curl -sf localhost:8080/docs/asyncapi -o asyncapi-docs.json
working-directory: projects/${{ matrix.project }}/tech-docs/build
- uses: actions/upload-artifact@v4
with:
name: ${{ matrix.project }}
path: projects/${{ matrix.project }}/tech-docs/build
post-build:
name: Post-build
runs-on: ubuntu-latest
needs:
- build-index
- build-projects
if: always()
steps:
- name: Check build matrix status
if: ${{ needs.build-index.result != 'success' || needs.build-projects.result != 'success' }}
run: exit 1
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@920cbb300dcd3f0568dbc42700c61e2fd9e6139c # v4.6.4
with:
folder: tech-docs
target-folder: tech-docs
- name: Deploy branch
if: github.ref_name != 'main'
uses: JamesIves/github-pages-deploy-action@920cbb300dcd3f0568dbc42700c61e2fd9e6139c # v4.6.4
with:
folder: tech-docs
target-folder: tech-docs-drafts/${{ github.ref_name }}