Skip to content

feat(workflows): support project-specific extra targets #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArcanePivot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(workflows): support project-specific extra targets #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 39 additions & 5 deletions .github/workflows/zig-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ on:
{"os":"macos-latest","target":"macos-aarch64","zig_target":"aarch64-macos"},
{"os":"windows-latest","target":"windows-x86_64","zig_target":"x86_64-windows"}
]
extra_targets_json:
description: JSON array of project-specific target entries appended to targets_json.
required: false
type: string
default: "[]"
node_version:
description: Optional Node.js version to install before custom commands.
required: false
Expand Down Expand Up @@ -82,16 +87,42 @@ env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"

jobs:
targets:
name: Resolve target matrix
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.merge.outputs.matrix }}

steps:
- name: Merge target matrices
id: merge
env:
TARGETS_JSON: ${{ inputs.targets_json }}
EXTRA_TARGETS_JSON: ${{ inputs.extra_targets_json }}
run: |
merged="$(jq -cn \
--argjson targets "${TARGETS_JSON}" \
--argjson extra "${EXTRA_TARGETS_JSON}" \
'$targets + $extra')"
jq -e 'type == "array" and length > 0 and all(.[]; type == "object" and has("os") and has("target") and has("zig_target") and ((has("build_args") | not) or (.build_args | type == "string")))' \
<<< "${merged}" >/dev/null
if [ "$(jq '[.[].target] | length' <<< "${merged}")" -ne "$(jq '[.[].target] | unique | length' <<< "${merged}")" ]; then
echo "target names must be unique across targets_json and extra_targets_json" >&2
exit 1
fi
echo "matrix=${merged}" >> "$GITHUB_OUTPUT"

test:
name: ${{ matrix.target }}
needs: targets
runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(inputs.targets_json) }}
include: ${{ fromJson(needs.targets.outputs.matrix) }}

steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
Expand Down Expand Up @@ -159,15 +190,18 @@ jobs:
- name: Build ReleaseSmall
env:
EXTRA_BUILD_ARGS: ${{ inputs.build_args }}
TARGET_BUILD_ARGS: ${{ matrix.build_args }}
run: |
zig_args=(
-Dtarget=${{ matrix.zig_target }}
-Doptimize=ReleaseSmall
)
if [ -n "${EXTRA_BUILD_ARGS}" ]; then
read -r -a extra_args <<< "${EXTRA_BUILD_ARGS}"
zig_args+=("${extra_args[@]}")
fi
for build_args in "${EXTRA_BUILD_ARGS}" "${TARGET_BUILD_ARGS}"; do
if [ -n "${build_args}" ]; then
read -r -a extra_args <<< "${build_args}"
zig_args+=("${extra_args[@]}")
fi
done
zig build "${zig_args[@]}"

- name: Run E2E command
Expand Down
37 changes: 32 additions & 5 deletions .github/workflows/zig-nightly.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ on:
{"os":"windows-latest","target":"windows-x86_64","zig_target":"x86_64-windows","zig_cpu":"","ext":".exe"},
{"os":"windows-latest","target":"windows-aarch64","zig_target":"aarch64-windows","zig_cpu":"","ext":".exe"}
]
extra_targets_json:
description: JSON array of project-specific nightly targets appended to targets_json.
required: false
type: string
default: "[]"
node_version:
description: Optional Node.js version to install before custom commands.
required: false
Expand Down Expand Up @@ -114,6 +119,7 @@ jobs:
short_sha: ${{ steps.version.outputs.short_sha }}
artifact_prefix: ${{ steps.version.outputs.artifact_prefix }}
built_at: ${{ steps.version.outputs.built_at }}
matrix: ${{ steps.targets.outputs.matrix }}

steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
Expand All @@ -138,6 +144,24 @@ jobs:
echo "value=nightly-${build_date}-${short_sha}" >> "$GITHUB_OUTPUT"
echo "artifact_prefix=${artifact_prefix}" >> "$GITHUB_OUTPUT"

- name: Merge target matrices
id: targets
env:
TARGETS_JSON: ${{ inputs.targets_json }}
EXTRA_TARGETS_JSON: ${{ inputs.extra_targets_json }}
run: |
merged="$(jq -cn \
--argjson targets "${TARGETS_JSON}" \
--argjson extra "${EXTRA_TARGETS_JSON}" \
'$targets + $extra')"
jq -e 'type == "array" and length > 0 and all(.[]; type == "object" and has("os") and has("target") and has("zig_target") and ((has("build_args") | not) or (.build_args | type == "string")))' \
<<< "${merged}" >/dev/null
if [ "$(jq '[.[].target] | length' <<< "${merged}")" -ne "$(jq '[.[].target] | unique | length' <<< "${merged}")" ]; then
echo "target names must be unique across targets_json and extra_targets_json" >&2
exit 1
fi
echo "matrix=${merged}" >> "$GITHUB_OUTPUT"

- name: Fetch previous successful workflow runs
env:
GH_TOKEN: ${{ github.token }}
Expand Down Expand Up @@ -181,7 +205,7 @@ jobs:
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(inputs.targets_json) }}
include: ${{ fromJson(needs.preflight.outputs.matrix) }}

steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
Expand Down Expand Up @@ -256,6 +280,7 @@ jobs:
env:
ANDROID_API_LEVEL: ${{ inputs.android_api_level }}
EXTRA_BUILD_ARGS: ${{ inputs.build_args }}
TARGET_BUILD_ARGS: ${{ matrix.build_args }}
run: |
zig_target="${{ matrix.zig_target }}"
if [[ "${{ matrix.target }}" == android-* ]]; then
Expand All @@ -273,10 +298,12 @@ jobs:
if [[ "${{ matrix.target }}" == android-* ]]; then
zig_args+=(--libc "${ZIG_ANDROID_LIBC_FILE}")
fi
if [ -n "${EXTRA_BUILD_ARGS}" ]; then
read -r -a extra_args <<< "${EXTRA_BUILD_ARGS}"
zig_args+=("${extra_args[@]}")
fi
for build_args in "${EXTRA_BUILD_ARGS}" "${TARGET_BUILD_ARGS}"; do
if [ -n "${build_args}" ]; then
read -r -a extra_args <<< "${build_args}"
zig_args+=("${extra_args[@]}")
fi
done
zig build "${zig_args[@]}"

- name: Package nightly artifact
Expand Down
44 changes: 39 additions & 5 deletions .github/workflows/zig-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ on:
{"os":"windows-latest","target":"windows-x86_64","zig_target":"x86_64-windows","zig_cpu":"","ext":".exe"},
{"os":"windows-latest","target":"windows-aarch64","zig_target":"aarch64-windows","zig_cpu":"","ext":".exe"}
]
extra_targets_json:
description: JSON array of project-specific release targets appended to targets_json.
required: false
type: string
default: "[]"
node_version:
description: Optional Node.js version to install before custom commands.
required: false
Expand Down Expand Up @@ -104,16 +109,42 @@ env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"

jobs:
targets:
name: Resolve target matrix
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.merge.outputs.matrix }}

steps:
- name: Merge target matrices
id: merge
env:
TARGETS_JSON: ${{ inputs.targets_json }}
EXTRA_TARGETS_JSON: ${{ inputs.extra_targets_json }}
run: |
merged="$(jq -cn \
--argjson targets "${TARGETS_JSON}" \
--argjson extra "${EXTRA_TARGETS_JSON}" \
'$targets + $extra')"
jq -e 'type == "array" and length > 0 and all(.[]; type == "object" and has("os") and has("target") and has("zig_target") and ((has("build_args") | not) or (.build_args | type == "string")))' \
<<< "${merged}" >/dev/null
if [ "$(jq '[.[].target] | length' <<< "${merged}")" -ne "$(jq '[.[].target] | unique | length' <<< "${merged}")" ]; then
echo "target names must be unique across targets_json and extra_targets_json" >&2
exit 1
fi
echo "matrix=${merged}" >> "$GITHUB_OUTPUT"

build:
name: Build (${{ matrix.target }})
needs: targets
runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(inputs.targets_json) }}
include: ${{ fromJson(needs.targets.outputs.matrix) }}

steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
Expand Down Expand Up @@ -206,6 +237,7 @@ jobs:
env:
ANDROID_API_LEVEL: ${{ inputs.android_api_level }}
EXTRA_BUILD_ARGS: ${{ inputs.build_args }}
TARGET_BUILD_ARGS: ${{ matrix.build_args }}
run: |
zig_target="${{ matrix.zig_target }}"
if [[ "${{ matrix.target }}" == android-* ]]; then
Expand All @@ -222,10 +254,12 @@ jobs:
if [[ "${{ matrix.target }}" == android-* ]]; then
zig_args+=(--libc "${ZIG_ANDROID_LIBC_FILE}")
fi
if [ -n "${EXTRA_BUILD_ARGS}" ]; then
read -r -a extra_args <<< "${EXTRA_BUILD_ARGS}"
zig_args+=("${extra_args[@]}")
fi
for build_args in "${EXTRA_BUILD_ARGS}" "${TARGET_BUILD_ARGS}"; do
if [ -n "${build_args}" ]; then
read -r -a extra_args <<< "${build_args}"
zig_args+=("${extra_args[@]}")
fi
done
zig build "${zig_args[@]}"

- name: Upload artifact
Expand Down
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,30 @@ jobs:
]
```

Use `targets_json` when a project needs to replace the default matrix. Use
`extra_targets_json` to keep every default target and append only the targets
specific to that project:

```yaml
jobs:
zig:
uses: nullclaw/nullbuilder/.github/workflows/zig-ci.yml@v1
permissions:
contents: read
with:
binary_name: nullclaw
artifact_prefix: nullclaw
extra_targets_json: >-
[
{"os":"ubuntu-latest","target":"linux-mipsel-musl","zig_target":"mipsel-linux-musleabi","build_args":"-Dembedded_wasm3=false"}
]
```

`extra_targets_json` is available in the CI, nightly, and release workflows.
Target names must remain unique after the two arrays are merged. An optional
per-target `build_args` string is appended after the workflow-level build
arguments and is useful when one architecture needs a feature override.

### Nightly

```yaml
Expand Down
Loading