-
Notifications
You must be signed in to change notification settings - Fork 14
399 lines (362 loc) · 16.6 KB
/
build-image.yaml
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
name: Build and push multi-arch image
on:
workflow_call:
inputs:
buildType:
description: Decide on what to build
required: true
type: string
gitRef:
description: Commit, tag or branch name to build
required: false
type: string
workflow_dispatch:
inputs:
buildType:
description: Decide on what to build
required: true
type: choice
options:
- build_only
- build_push_ckan
- build_push_ckan_with_gittag
- build_push_base
- build_push_pycsw
- build_push_solr
- build_push_test_ckan
gitRef:
description: Commit, tag or branch name to build
required: false
type: string
push:
branches:
- main
schedule:
- cron: '0 3 * * 0'
env:
BUILD_TYPE : ${{ inputs.buildType || 'build_push_ckan' }}
REGISTRY_BASE: ghcr.io/alphagov
jobs:
configure_builds:
name: Read configuration from build-config.yaml
runs-on: ubuntu-latest
outputs:
build_type: ${{ steps.set-matrix.outputs.build_type }}
runs_on: ${{ steps.set-matrix.outputs.runs_on }}
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.gitRef || github.ref }}
show-progress: false
- id: set-matrix
run: |
input_build_type="${{ env.BUILD_TYPE }}"
build_type=$(yq -o=json "explode(.) .build_types.$input_build_type" build-config.yaml | jq -r '[. [] | {name: .name, version: .version, patch: .patch}] | @json')
runs_on=$(yq -o=json '.runs_on' build-config.yaml | jq -r '[.[] | {runner_type: .runner_type, arch: .arch}] | @json')
echo "[DEBUG] build_type: $build_type"
echo "[DEBUG] runs_on: $runs_on"
echo "build_type=$build_type" >> "$GITHUB_OUTPUT"
echo "runs_on=$runs_on" >> "$GITHUB_OUTPUT"
build_push_multiarch_image:
name: Build ${{ matrix.app.name }} for ${{ matrix.runs_on.arch }}
needs: configure_builds
strategy:
matrix:
app: ${{ fromJson(needs.configure_builds.outputs.build_type) }}
runs_on: ${{ fromJson(needs.configure_builds.outputs.runs_on) }}
runs-on: ${{ matrix.runs_on.runner_type }}
permissions:
packages: write
steps:
- name: Login to GHCR
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Git Checkout
uses: actions/checkout@v4
with:
ref: ${{ inputs.gitRef || github.ref }}
show-progress: false
- name: Setup Docker BuildX
uses: docker/setup-buildx-action@v3
- name: Calculate Image Tags
id: calculate-image-tags
run: |
CREATED_DATE="$(date -u +'%Y-%m-%dT%H:%M:%SZ')"
echo "createdDate=${CREATED_DATE}" >> "$GITHUB_OUTPUT"
- name: Determine Image Tags
id: determine-image-tags
run: |
buildType="${{ env.BUILD_TYPE }}"
if [ "$buildType" = "build_push_ckan_with_gittag" ]; then
echo "GH_TAG=${{ inputs.gitRef || github.ref }}" >> $GITHUB_ENV
else
echo "GH_TAG=${{ github.sha }}" >> $GITHUB_ENV
fi
case $buildType in
"build_only" | "build_push_pycsw")
echo "BUILD_TAGS=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
;;
"build_push_base")
echo "BUILD_TAGS=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
echo "BUILD_CKAN_BASE=true" >> $GITHUB_ENV
echo "ADD_PATCH_TAG=true" >> $GITHUB_ENV
echo "APP_TAG_SUFFIX=-core" >> $GITHUB_ENV
;;
"build_push_test_ckan")
echo "BUILD_TAGS=${{ matrix.app.version }}-test" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
echo "BUILD_CKAN_BASE=true" >> $GITHUB_ENV
echo "ADD_PATCH_TAG=true" >> $GITHUB_ENV
echo "APP_TAG_SUFFIX=-core" >> $GITHUB_ENV
;;
"build_push_ckan_with_gittag")
echo "BUILD_TAGS=${{ inputs.gitRef || github.ref }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
;;
*)
echo "BUILD_TAGS=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
;;
esac
- name: Generate App Image Metadata
uses: docker/metadata-action@v5
id: app-metadata
with:
flavor: |
latest=false
images: |
${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}
tags: |
type=raw,value=${{ env.GH_TAG }}
type=raw,value=${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}
type=raw,value=${{ env.BUILD_TAGS }}-${{ matrix.app.patch }}${{ env.APP_TAG_SUFFIX }},enable=${{ matrix.app.patch != '' && env.ADD_PATCH_TAG == 'true' }}
type=sha,prefix${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}-,format=short
type=sha,priority=100,format=long,prefix=${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}-
labels: |
org.opencontainers.image.title=${{ matrix.app.name }}
org.opencontainers.image.authors="GOV.UK Platform Engineering"
org.opencontainers.image.description="Core image for data.gov.uk ${{ matrix.app.name }}"
org.opencontainers.image.source="https://github.com/alphagov/ckanext-datagovuk"
org.opencontainers.image.version=${{ env.BUILD_TAGS }}
org.opencontainers.image.created=${{ steps.calculate-image-tags.outputs.createdDate }}
org.opencontainers.image.vendor=GDS
- name: Build App Image
id: build-app-image
uses: docker/build-push-action@v6
with:
file: docker/${{ matrix.app.name }}/${{ matrix.app.version }}${{ env.APP_TAG_SUFFIX }}.Dockerfile
context: .
platforms: "linux/${{ matrix.runs_on.arch }}"
load: true
provenance: false
labels: ${{ steps.app-metadata.outputs.labels }}
outputs: |
type=image,name=${{ env.REGISTRY_BASE }}/${{ matrix.app.name }},push-by-digest=true,name-canonical=true,push=true
cache-from: type=gha,scope=${{ matrix.app.name }}-${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}-${{ matrix.runs_on.arch }}
cache-to: type=gha,scope=${{ matrix.app.name }}-${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}-${{ matrix.runs_on.arch }},mode=max
- name: Generate Base Image Metadata
if: ${{ env.BUILD_CKAN_BASE == 'true' }}
uses: docker/metadata-action@v5
id: base-metadata
with:
flavor: |
latest=false
images: |
${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}
tags: |
type=raw,value=${{ env.BUILD_TAGS }}-base
type=raw,value=${{ env.BUILD_TAGS }}-${{ matrix.app.patch }}-base,enable=${{ matrix.app.patch != '' && env.ADD_PATCH_TAG == 'true' }}
type=sha,prefix${{ env.BUILD_TAGS }}-base-,format=short
type=sha,priority=100,format=long,prefix=${{ env.BUILD_TAGS }}-base
labels: |
org.opencontainers.image.title=${{ matrix.app.name }}
org.opencontainers.image.authors="GOV.UK Platform Engineering"
org.opencontainers.image.description="Base image for data.gov.uk ${{ matrix.app.name }}"
org.opencontainers.image.source="https://github.com/alphagov/ckanext-datagovuk"
org.opencontainers.image.version=${{ matrix.app.version }}
org.opencontainers.image.created=${{ steps.calculate-image-tags.outputs.createdDate }}
org.opencontainers.image.vendor=GDS
- name: Build Base Image (CKAN Only)
if: ${{ env.BUILD_CKAN_BASE == 'true' }}
id: build-base-image
uses: docker/build-push-action@v6
with:
file: docker/${{ matrix.app.name }}/${{ matrix.app.version }}-base.Dockerfile
context: .
platforms: "linux/${{ matrix.runs_on.arch }}"
load: true
provenance: false
labels: ${{ steps.base-metadata.outputs.labels }}
build-args: BASE_IMAGE=${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}@${{ steps.build-app-image.outputs.digest }}
outputs: type=image,name=${{ env.REGISTRY_BASE }}/${{ matrix.app.name }},push-by-digest=true,name-canonical=true,push=true
cache-from: type=gha,scope=${{ matrix.app.name }}-${{ env.BUILD_TAGS }}-base-${{ matrix.runs_on.arch }}
cache-to: type=gha,scope=${{ matrix.app.name }}-${{ env.BUILD_TAGS }}-base-${{ matrix.runs_on.arch }},mode=max
- name: Export Image Digests
if: ${{ env.BUILD_TYPE != 'build_only' }}
id: export-digests
env:
DIGEST: "${{ steps.build-app-image.outputs.digest }}"
run: |
mkdir -p /tmp/digests/app
touch "/tmp/digests/app/${DIGEST#sha256:}"
- name: Export Base Image Digests
if: ${{ env.BUILD_TYPE != 'build_only' && env.BUILD_CKAN_BASE == 'true' }}
id: export-base-digests
env:
DIGEST: "${{ steps.build-base-image.outputs.digest }}"
run: |
mkdir -p /tmp/digests/base
touch "/tmp/digests/base/${DIGEST#sha256:}"
- name: Upload Digest Artifacts
if: ${{ env.BUILD_TYPE != 'build_only' }}
id: upload-digests
uses: actions/upload-artifact@v4
with:
name: digests-${{ matrix.app.name }}-${{ env.BUILD_TAGS }}-${{ matrix.runs_on.arch }}
path: /tmp/digests/*
if-no-files-found: error
retention-days: 1
overwrite: true
create_image_manifest:
if: ${{ inputs.buildType != 'build_only' }} // Does not support `env` context.
name: Create Image Manifest
needs:
- configure_builds
- build_push_multiarch_image
strategy:
matrix:
app: ${{ fromJson(needs.configure_builds.outputs.build_type) }}
runs-on: ubuntu-latest
permissions:
id-token: write
contents: read
packages: write
steps:
- name: Setup Docker BuildX
uses: docker/setup-buildx-action@v3
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Determine Image Tags
id: determine-image-tags
run: |
buildType="${{ env.BUILD_TYPE }}"
if [ "$buildType" = "build_push_ckan_with_gittag" ]; then
echo "GH_TAG=${{ inputs.gitRef || github.ref }}" >> $GITHUB_ENV
else
echo "GH_TAG=${{ github.sha }}" >> $GITHUB_ENV
fi
case $buildType in
"build_only" | "build_push_pycsw")
echo "BUILD_TAGS=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
;;
"build_push_base")
echo "BUILD_TAGS=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
echo "BUILD_CKAN_BASE=true" >> $GITHUB_ENV
echo "APP_TAG_SUFFIX=-core" >> $GITHUB_ENV
;;
"build_push_test_ckan")
echo "BUILD_TAGS=${{ matrix.app.version }}-test" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
echo "BUILD_CKAN_BASE=true" >> $GITHUB_ENV
echo "APP_TAG_SUFFIX=-core" >> $GITHUB_ENV
;;
"build_push_ckan_with_gittag")
echo "BUILD_TAGS=${{ inputs.gitRef || github.ref }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}" >> $GITHUB_ENV
;;
*)
echo "BUILD_TAGS=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
echo "DOCKERFILE=${{ matrix.app.version }}-${{ matrix.app.patch }}" >> $GITHUB_ENV
;;
esac
- name: Download Image Digests
uses: actions/download-artifact@v4
with:
path: /tmp/digests
pattern: digests-${{ matrix.app.name }}-${{ env.BUILD_TAGS }}-*
merge-multiple: true
- name: Generate App Image Metadata
uses: docker/metadata-action@v5
id: app-metadata
with:
flavor: |
latest=false
images: |
${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}
tags: |
type=raw,value=${{ env.GH_TAG }}
type=raw,value=${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}
type=raw,value=${{ env.BUILD_TAGS }}-${{ matrix.app.patch }}${{ env.APP_TAG_SUFFIX }},enable=${{ matrix.app.patch != '' && env.ADD_PATCH_TAG == 'true' }}
type=sha,prefix${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}-,format=short
type=sha,priority=100,format=long,prefix=${{ env.BUILD_TAGS }}${{ env.APP_TAG_SUFFIX }}-
labels: |
org.opencontainers.image.title=${{ matrix.app.name }}
org.opencontainers.image.authors="GOV.UK Platform Engineering"
org.opencontainers.image.description="Core image for data.gov.uk ${{ matrix.app.name }}"
org.opencontainers.image.source="https://github.com/alphagov/ckanext-datagovuk"
org.opencontainers.image.version=${{ env.BUILD_TAGS }}
org.opencontainers.image.created=${{ steps.calculate-image-tags.outputs.createdDate }}
org.opencontainers.image.vendor=GDS.opencontainers.image.vendor=GDS
- name: Create App Manifest Lists
env:
IMAGEREF_PREFIX: '${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}'
working-directory: /tmp/digests/app
run: |
tag_args=$(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON")
printf -v sources "${IMAGEREF_PREFIX}@sha256:%s " *
# shellcheck disable=SC2086 # Intentional word-splitting on $tag_args and $sources.
docker buildx imagetools create $tag_args $sources
- name: Generate Base Image Metadata
if: ${{ env.BUILD_CKAN_BASE == 'true' }}
uses: docker/metadata-action@v5
id: base-metadata
with:
flavor: |
latest=false
images: |
${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}
tags: |
type=raw,value=${{ env.BUILD_TAGS }}-base
type=raw,value=${{ env.BUILD_TAGS }}-${{ matrix.app.patch }}-base,enable=${{ matrix.app.patch != '' && env.ADD_PATCH_TAG == 'true' }}
type=sha,prefix${{ env.BUILD_TAGS }}-base-,format=short
type=sha,priority=100,format=long,prefix=${{ env.BUILD_TAGS }}-base
labels: |
org.opencontainers.image.title=${{ matrix.app.name }}
org.opencontainers.image.authors="GOV.UK Platform Engineering"
org.opencontainers.image.description="Base image for data.gov.uk ${{ matrix.app.name }}"
org.opencontainers.image.source="https://github.com/alphagov/ckanext-datagovuk"
org.opencontainers.image.version=${{ matrix.app.version }}
org.opencontainers.image.created=${{ steps.calculate-image-tags.outputs.createdDate }}
org.opencontainers.image.vendor=GDS
- name: Create Base Manifest Lists
if: ${{ env.BUILD_CKAN_BASE == 'true' }}
env:
IMAGEREF_PREFIX: '${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}'
working-directory: /tmp/digests/base
run: |
tag_args=$(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON")
printf -v sources "${IMAGEREF_PREFIX}@sha256:%s " *
# shellcheck disable=SC2086 # Intentional word-splitting on $tag_args and $sources.
docker buildx imagetools create $tag_args $sources
- name: Inspect App Images
env:
IMAGEREF: '${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}:${{ steps.app-metadata.outputs.version }}'
run: |
docker buildx imagetools inspect "$IMAGEREF"
- name: Inspect Base Images
if: ${{ env.BUILD_CKAN_BASE == 'true' }}
env:
IMAGEREF: '${{ env.REGISTRY_BASE }}/${{ matrix.app.name }}:${{ steps.base-metadata.outputs.version }}'
run: |
docker buildx imagetools inspect "$IMAGEREF"