Skip to content

Commit 275468e

Browse files
update build workflow with multiplatform image support and documentation
1 parent 6a67800 commit 275468e

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

.github/workflows/build.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
name: Build
22

3+
# This workflow builds multiple quickstart images as defined in the images.json
4+
# file.
5+
#
6+
# The dependencies (xdr, core, rpc, horizon, friendbot, lab) are first
7+
# deduplicated across all images, and then built. Dependencies are cached and
8+
# so only rebuilt when needed. Dependencies are defined by a tag or branch, but
9+
# when building those git refs are resolved to a sha to ensure stability of the
10+
# sha throughout the full build process. For all dependencies and the final
11+
# image, amd64 and arm64 variants are built and the final image is a
12+
# multiplatform image.
13+
#
14+
# The images defined in the images.json file can specify what events the images
15+
# are built on. Most of the images will be built on push and pull requests, but
16+
# this workflow also runs on a schedule an so images that need updating on a
17+
# schedule, such as a nightly-like image, can specify running additionally or
18+
# only on the schedule.
19+
#
20+
# This workflow is also triggerable via a workflow call from another workflow.
21+
# When used that way, the image only builds a single amd64 image and it is not
22+
# pushed. The workflow returns an output which is an artifact name that can be
23+
# downloaded and loaded into docker for use in another job. The workflow can be
24+
# improved to support multiple images in the workflow call case, it just
25+
# requires more work to do so.
26+
327
on:
428
push:
529
branches:

.github/workflows/workflow-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
steps:
3434
- uses: actions/download-artifact@v4
3535
with:
36-
name: ${{ needs.build-custom.outputs.image_artifact }}
36+
name: ${{ needs.build-custom.outputs.image_artifact
3737
path: /tmp/
3838
- run: docker load -i /tmp/image
3939
- run: >

0 commit comments

Comments
 (0)