summaryrefslogtreecommitdiff
path: root/.github/workflows
diff options
context:
space:
mode:
Diffstat (limited to '.github/workflows')
-rw-r--r--.github/workflows/build.yml235
-rw-r--r--.github/workflows/build_util.yml62
2 files changed, 257 insertions, 40 deletions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 8f6014f48..70555b111 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -37,7 +37,11 @@ jobs:
- 'hw/**'
- 'test/hil/**'
- 'tools/build.py'
+ - 'tools/build_utils.py'
+ - 'tools/ci_select.py'
- 'tools/get_deps.py'
+ - 'tools/metrics.py'
+ - 'tools/rtt.py'
- '.github/actions/**'
- '.github/workflows/build.yml'
- '.github/workflows/build_util.yml'
@@ -48,6 +52,9 @@ jobs:
outputs:
json: ${{ steps.set-matrix-json.outputs.matrix }}
hil_json: ${{ steps.set-matrix-json.outputs.hil_matrix }}
+ example_map: ${{ steps.set-matrix-json.outputs.example_map }}
+ build_filtered: ${{ steps.set-matrix-json.outputs.build_filtered }}
+ build_families_regex: ${{ steps.set-matrix-json.outputs.build_families_regex }}
# one pair per rig job: hil-tinyusb (tinyusb.json minus esptool boards),
# hil-tinyusb-esp (esptool boards only), hil-tinyusb (hfp.json)
hil_args_tinyusb: ${{ steps.hil-select.outputs.args_tinyusb }}
@@ -62,7 +69,7 @@ jobs:
with:
fetch-depth: 0
- - name: HIL selection (PR only)
+ - name: CI selection (PR only)
id: hil-select
if: github.event_name == 'pull_request'
env:
@@ -79,55 +86,147 @@ jobs:
# advisory workflow that nothing here can `needs:`. Test-failing selector =>
# full matrix, same as a crashing one.
SELECT_JSON=''
- if ! python3 test/hil/test/test_hil_select.py; then
- echo "::warning::hil_select unit suite failed - falling back to the full HIL matrix"
- elif ! SELECT_JSON=$(python3 test/hil/helper/hil_select.py --base "origin/$BASE_REF" test/hil/tinyusb.json test/hil/hfp.json); then
- echo "::warning::hil_select failed - falling back to the full HIL matrix"
+ if ! python3 test/hil/test/test_ci_select.py; then
+ echo "::warning::ci_select unit suite failed - falling back to the full HIL matrix"
+ elif ! SELECT_JSON=$(python3 tools/ci_select.py --base "origin/$BASE_REF" test/hil/tinyusb.json test/hil/hfp.json); then
+ echo "::warning::ci_select failed - falling back to the full HIL matrix"
SELECT_JSON=''
fi
+ # The selection is handed on as a FILE in the workspace, never as a step
+ # output/env var: it is ~KBs normally but a mass-sweep PR reaches hundreds of
+ # KB, and an env var that big makes the consuming exec fail with E2BIG BEFORE
+ # any fallback in it can run. Written here, ahead of its first reader.
+ # No file (non-PR event, or any fallback) = full matrix.
+ rm -f ci_select_out.json
+ if [ -n "$SELECT_JSON" ]; then
+ printf '%s' "$SELECT_JSON" > ci_select_out.json
+ fi
+
# One args/run pair per rig job, split by flasher: a job whose own subset is
# empty skips explicitly instead of running a board filter that matches zero
# boards ("No tests were run." exits 0 and would read as a green HIL run).
OUT=''
- if [ -n "$SELECT_JSON" ]; then
- OUT=$(SELECT_JSON="$SELECT_JSON" python3 -c '
- import json, os
- s = json.loads(os.environ["SELECT_JSON"])
+ if [ -s ci_select_out.json ]; then
+ OUT=$(python3 -c '
+ import json, re, sys
+ s = json.load(open("ci_select_out.json"))
+ # the same reading hil_ci_set_matrix.py applies: full false with no usable
+ # boards map is an UNUSABLE selection, not "nothing selected". Both must agree
+ # - one falling open to the whole roster while the other computes run=false
+ # buys a full 37-leg build and still zero hardware coverage.
+ if not s.get("full") and not isinstance(s.get("boards"), dict):
+ sys.exit("selection has full false but no usable boards map")
tin = s.get("args_flasher", {}).get("tinyusb.json", {})
legs = (("tinyusb", " ".join(a for f, a in sorted(tin.items()) if f != "esptool" and a)),
("tinyusb_esp", tin.get("esptool", "")),
("hfp", s.get("args", {}).get("hfp.json", "")))
for key, a in legs:
+ # roster board names reach $GITHUB_OUTPUT as bare NAME=VALUE lines; a
+ # newline in one would inject extra run_* lines and flip which rig jobs run.
+ # ":" and "," are part of the normal shape - a partial filter is
+ # `-bt <board>:<test>,<test>` (ci_select._board_args)
+ if not re.fullmatch(r"[-A-Za-z0-9_/ .=+:,]*", a):
+ sys.exit("unexpected characters in the " + key + " board filter")
print("args_" + key + "=" + a)
print("run_" + key + "=" + ("true" if (s.get("full") or a) else "false"))
') || OUT=''
if [ -z "$OUT" ]; then
- echo "::warning::hil_select output unusable - falling back to the full HIL matrix"
- SELECT_JSON=''
+ echo "::warning::ci_select output unusable - falling back to the full HIL matrix"
+ # the same unusable selection must not stay behind for the build axis
+ rm -f ci_select_out.json
fi
fi
if [ -z "$OUT" ]; then
OUT=$(for k in tinyusb tinyusb_esp hfp; do printf 'args_%s=\nrun_%s=true\n' "$k" "$k"; done)
fi
echo "$OUT"
- { echo "select=$SELECT_JSON"; echo "$OUT"; } >> $GITHUB_OUTPUT
+ echo "$OUT" >> $GITHUB_OUTPUT
- name: Generate matrix json
id: set-matrix-json
- env:
- SELECT: ${{ steps.hil-select.outputs.select }}
run: |
- # build matrix
- MATRIX_JSON=$(python .github/scripts/ci_set_matrix.py)
+ # Build matrix, scoped by the PR selection when one exists. Best-effort:
+ # ci_set_matrix falls back to the full matrix itself on unusable JSON,
+ # and a missing file (non-PR event, selector fallback) means no flags.
+ SELECT_FILE=ci_select_out.json
+ [ -s "$SELECT_FILE" ] || SELECT_FILE=''
+ BUILD_SELECT_FILE="$SELECT_FILE"
+ MATRIX_JSON=''
+ if [ -n "$SELECT_FILE" ]; then
+ # ci_set_matrix falls open on a selection it cannot use with rc 0 - it prints
+ # the full matrix and says UNSCOPED on stderr. The build extras below must
+ # not stay scoped when it did, or a nominally full build compiles 1 of 44
+ # examples per family and code-metrics compares that partial run against a
+ # full baseline. Only the BUILD axis is dropped: build.families being
+ # unusable says nothing about the boards map the HIL matrix reads.
+ MATRIX_JSON=$(python .github/scripts/ci_set_matrix.py --select-file "$SELECT_FILE" 2>ci_set_matrix.err) || MATRIX_JSON=''
+ cat ci_set_matrix.err >&2
+ if [ -z "$MATRIX_JSON" ] || grep -q 'ci_set_matrix: UNSCOPED' ci_set_matrix.err; then
+ BUILD_SELECT_FILE=''
+ fi
+ fi
+ [ -z "$MATRIX_JSON" ] && MATRIX_JSON=$(python .github/scripts/ci_set_matrix.py)
+
+ # Build-axis extras: the per-family example map rides as a side channel
+ # (a value inside matrix entries would break CircleCI's family parameter
+ # and multiply GHA matrix legs). These stay step outputs - they are small
+ # derived values, unlike the selection they are read from. NOTE jq's //
+ # treats false like null, so .build.full is compared explicitly.
+ EXAMPLE_MAP='{}'
+ BUILD_FILTERED='false'
+ FAMILY_REGEX=''
+ if [ -n "$BUILD_SELECT_FILE" ]; then
+ EXAMPLE_MAP=$(jq -c '.build.family_examples // {}' "$BUILD_SELECT_FILE") || EXAMPLE_MAP='{}'
+ BUILD_FILTERED=$(jq -r 'if (.build? | type) == "object" and .build.full == false then "true" else "false" end' "$BUILD_SELECT_FILE") || BUILD_FILTERED='false'
+ if [ "$BUILD_FILTERED" = "true" ]; then
+ FAMILY_COUNT=$(jq -r '.build.families | length' "$BUILD_SELECT_FILE") || FAMILY_COUNT=0
+ FAMILY_REGEX=$(jq -r '.build.families | join("|")' "$BUILD_SELECT_FILE") || FAMILY_REGEX=''
+ # family names come from hw/bsp dir names, which rule 6 reads straight out
+ # of the PR's diff path - and this is interpolated raw into a
+ # `name_is_regexp` artifact pattern, so a regex metacharacter there would
+ # silently match another family's baseline
+ FAMILY_REJECTED=0
+ case "$FAMILY_REGEX" in
+ *[!-A-Za-z0-9_\|]*)
+ echo "::warning::unexpected characters in the family list - dropping the scoping"
+ FAMILY_REGEX=''; FAMILY_REJECTED=1 ;;
+ esac
+ # An EMPTY families list and a REJECTED one both leave FAMILY_REGEX empty and
+ # mean opposite things, so branch on which happened. Testing `-z` alone sent
+ # every nothing-selected PR down the fall-open path: a docs/.gitignore diff
+ # (#3842) and a test/hil-only diff (#3840) each rebuilt all 74 cmake legs
+ # after the selector had correctly chosen none.
+ if [ "$FAMILY_REJECTED" = "1" ]; then
+ # unusable: fall open, and all three drop together. Resetting only
+ # build_filtered leaves the build scoped while code-metrics takes the
+ # UNSCOPED branch, diffing a 1-family run against the full averaged
+ # baseline and publishing that as the PR's code-size impact.
+ BUILD_FILTERED='false'
+ EXAMPLE_MAP='{}'
+ MATRIX_JSON=$(python .github/scripts/ci_set_matrix.py)
+ elif [ "$FAMILY_COUNT" = "0" ]; then
+ # legitimate nothing-selected. MATRIX_JSON already holds the all-empty
+ # matrix ci_set_matrix produced from this selection - keep it, so every
+ # leg skips. Nothing is built, so there is nothing to compare a baseline
+ # against: build_filtered goes false to keep code-metrics off the scoped
+ # path, and EXAMPLE_MAP stays '{}' (family_examples is empty anyway).
+ BUILD_FILTERED='false'
+ fi
+ fi
+ fi
+ # emitted once, after every path that can still change it
echo "matrix=$MATRIX_JSON"
echo "matrix=$MATRIX_JSON" >> $GITHUB_OUTPUT
+ echo "example_map=$EXAMPLE_MAP" >> $GITHUB_OUTPUT
+ echo "build_filtered=$BUILD_FILTERED" >> $GITHUB_OUTPUT
+ echo "build_families_regex=$FAMILY_REGEX" >> $GITHUB_OUTPUT
# HIL matrix (merged from tinyusb + hifiphile configs), scoped on PRs.
# Scoping is best-effort too: fall back to the unscoped (full) matrix.
HIL_MATRIX_JSON=''
- if [ -n "$SELECT" ]; then
- HIL_MATRIX_JSON=$(python .github/scripts/hil_ci_set_matrix.py --select "$SELECT" test/hil/tinyusb.json test/hil/hfp.json) || HIL_MATRIX_JSON=''
+ if [ -n "$SELECT_FILE" ]; then
+ HIL_MATRIX_JSON=$(python .github/scripts/hil_ci_set_matrix.py --select-file "$SELECT_FILE" test/hil/tinyusb.json test/hil/hfp.json) || HIL_MATRIX_JSON=''
if [ -z "$HIL_MATRIX_JSON" ]; then
echo "::warning::scoped HIL matrix failed - falling back to the full HIL matrix"
fi
@@ -162,6 +261,7 @@ jobs:
toolchain: ${{ matrix.toolchain }}
build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)[matrix.toolchain]) }}
build-options: '--one-first'
+ example-map: ${{ needs.set-matrix.outputs.example_map }}
upload-metrics: true
upload-artifacts: false
upload-membrowse: true
@@ -169,8 +269,17 @@ jobs:
secrets: inherit
code-metrics:
- needs: [ check-paths, cmake ]
- if: needs.check-paths.outputs.code_changed == 'true'
+ needs: [ check-paths, cmake, set-matrix ]
+ # A scoped selection can empty every cmake toolchain (a test/hil-only PR). This
+ # job must still run then: skipping it leaves the sticky comment showing the
+ # PREVIOUS push's size table as if it were current. set-matrix must have
+ # SUCCEEDED though: !cancelled() alone let a failed set-matrix through, and this
+ # job would then overwrite the sticky comment with a wrong "built no families"
+ # diagnosis while reporting itself green.
+ if: |
+ !cancelled() && needs.check-paths.outputs.code_changed == 'true' &&
+ needs.set-matrix.result == 'success' &&
+ (needs.cmake.result == 'success' || needs.cmake.result == 'skipped')
runs-on: ubuntu-latest
permissions:
pull-requests: write
@@ -187,8 +296,21 @@ jobs:
pattern: metrics-*
path: cmake-build
merge-multiple: true
+ # download-artifact does not fail on a pattern that matches nothing, so a
+ # scoped PR that built no family simply lands here with an empty dir
+
+ - name: Detect empty metrics set
+ run: |
+ # No metrics at all => nothing to aggregate or compare. Write the marker the
+ # sticky comment will carry, so the size section says "skipped" for THIS push
+ # instead of silently keeping the previous push's table.
+ if ! ls cmake-build/*/metrics.json >/dev/null 2>&1; then
+ echo "_Code-size comparison skipped: PR selection built no families on this push._" > metrics_compare.md
+ echo "NO_METRICS=true" >> $GITHUB_ENV
+ fi
- name: Aggregate Code Metrics
+ if: env.NO_METRICS != 'true'
run: |
python tools/get_deps.py
python tools/metrics.py combine -j -m -f tinyusb/src cmake-build/*/metrics.json
@@ -201,7 +323,7 @@ jobs:
path: metrics.json
- name: Download Base Branch Metrics
- if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch'
+ if: env.NO_METRICS != 'true' && (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch') && needs.set-matrix.outputs.build_filtered != 'true'
uses: dawidd6/action-download-artifact@v11
with:
workflow: build.yml
@@ -211,6 +333,29 @@ jobs:
path: base-metrics
continue-on-error: true
+ - name: Download base per-family metrics (scoped PR)
+ if: env.NO_METRICS != 'true' && github.event_name == 'pull_request' && needs.set-matrix.outputs.build_filtered == 'true'
+ uses: dawidd6/action-download-artifact@v11
+ with:
+ workflow: build.yml
+ workflow_conclusion: ''
+ search_artifacts: true # a docs-only master push uploads no per-family artifacts
+ branch: ${{ github.base_ref }}
+ name: ^metrics-(${{ needs.set-matrix.outputs.build_families_regex }})$
+ name_is_regexp: true
+ path: base-family-metrics
+ continue-on-error: true
+
+ - name: Compare with Base Branch (scoped)
+ if: env.NO_METRICS != 'true' && github.event_name == 'pull_request' && needs.set-matrix.outputs.build_filtered == 'true'
+ run: |
+ # never fall back to the averaged metrics-tinyusb here: a scoped PR vs the
+ # 64-family/46-example average is exactly the mismatch this path prevents
+ python .github/scripts/metrics_pair_compare.py \
+ --base-dir base-family-metrics --new-dir cmake-build --out metrics_compare || \
+ echo "_Code-size comparison failed on the scoped path - see the code-metrics job log._" > metrics_compare.md
+ cat metrics_compare.md
+
- name: Download Previous Release Asset
if: github.event_name == 'release'
env:
@@ -224,7 +369,7 @@ jobs:
gh release download $PREV_TAG -p metrics.json -D base-metrics || echo "No metrics.json found in $PREV_TAG release"
- name: Compare with Base Branch
- if: github.event_name != 'push'
+ if: env.NO_METRICS != 'true' && github.event_name != 'push' && needs.set-matrix.outputs.build_filtered != 'true'
run: |
if [ -f base-metrics/metrics.json ]; then
python tools/metrics.py compare -m -f tinyusb/src base-metrics/metrics.json metrics.json
@@ -252,6 +397,9 @@ jobs:
path: |
metrics_compare.md
metrics.json
+ # metrics.json is absent when the selection built no family; the marker
+ # in metrics_compare.md is still what the sticky comment needs
+ if-no-files-found: ignore
- name: Post Code Metrics as PR Comment
if: (github.event_name == 'workflow_dispatch') || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false)
@@ -627,32 +775,32 @@ jobs:
run: |
# Best-effort: this job is deliberately decoupled from set-matrix so unrelated
# failures cannot kill hfp coverage - a selector failure here must likewise
- # fall back to the full hfp matrix (no hil_select.json, no SEL_* vars), never
+ # fall back to the full hfp matrix (no ci_select.json, no SEL_* vars), never
# fail the job.
- if ! python3 test/hil/test/test_hil_select.py; then
- echo "::warning::hil_select unit suite failed - running the full hfp matrix"
- rm -f hil_select.json
+ if ! python3 test/hil/test/test_ci_select.py; then
+ echo "::warning::ci_select unit suite failed - running the full hfp matrix"
+ rm -f ci_select.json
exit 0
fi
- if ! python3 test/hil/helper/hil_select.py --base "origin/$BASE_REF" test/hil/hfp.json > hil_select.json; then
- echo "::warning::hil_select failed - running the full hfp matrix"
- rm -f hil_select.json
+ if ! python3 tools/ci_select.py --base "origin/$BASE_REF" test/hil/hfp.json > ci_select.json; then
+ echo "::warning::ci_select failed - running the full hfp matrix"
+ rm -f ci_select.json
exit 0
fi
- # hil_select.json is passed to hil_ci_set_matrix.py --select below to scope the
+ # ci_select.json is passed to hil_ci_set_matrix.py --select below to scope the
# build; it already honours full=true by ignoring the board list.
# The hil_test.py args go to a file, never to $GITHUB_ENV: they are derived
# from roster board names, which a PR can edit. Only SEL_RUN (a literal
# true/false computed here, needed by the step-level `if:`) goes to the env.
if ! SEL_RUN=$(python3 -c '
import json
- s = json.load(open("hil_select.json"))
+ s = json.load(open("ci_select.json"))
a = s["args"]["hfp.json"]
open("hil_sel_args.txt", "w").write(a)
print("true" if (s["full"] or a) else "false")
'); then
- echo "::warning::hil_select output unusable - running the full hfp matrix"
- rm -f hil_select.json hil_sel_args.txt
+ echo "::warning::ci_select output unusable - running the full hfp matrix"
+ rm -f ci_select.json hil_sel_args.txt
exit 0
fi
echo "SEL_RUN=$SEL_RUN"
@@ -661,9 +809,17 @@ jobs:
- name: Get build boards
if: env.SEL_RUN != 'false'
run: |
- if [ -f hil_select.json ]; then
- MATRIX_JSON=$(python .github/scripts/hil_ci_set_matrix.py --select "$(cat hil_select.json)" test/hil/hfp.json)
- else
+ # --select-file, never --select "$(cat ...)": a whole selection as one argv
+ # can exceed MAX_ARG_STRLEN on a big diff, and this job's design is to fall
+ # back to the full hfp matrix on any selector trouble, not to fail the step.
+ MATRIX_JSON=''
+ if [ -f ci_select.json ]; then
+ MATRIX_JSON=$(python .github/scripts/hil_ci_set_matrix.py --select-file ci_select.json test/hil/hfp.json) || MATRIX_JSON=''
+ if [ -z "$MATRIX_JSON" ]; then
+ echo "::warning::scoped hfp matrix failed - building the full hfp matrix"
+ fi
+ fi
+ if [ -z "$MATRIX_JSON" ]; then
MATRIX_JSON=$(python .github/scripts/hil_ci_set_matrix.py test/hil/hfp.json)
fi
# Each variant carries its own --build-name/--cflag, which are global to a
@@ -672,6 +828,13 @@ jobs:
echo "$MATRIX_JSON" | jq -r '.["arm-gcc"][]' > hil_build_entries.txt
cat hil_build_entries.txt
BUILD_ARGS=$(echo "$MATRIX_JSON" | jq -r '.["arm-gcc"] | join(" ")')
+ # board and example names are roster data a PR can edit, and jq -r un-escapes
+ # them: a newline here writes extra NAME=VALUE lines into GITHUB_ENV for every
+ # later step of a job that holds the IAR token. Refuse rather than guess.
+ case "$BUILD_ARGS" in
+ *[!-A-Za-z0-9_/\ .=+]*)
+ echo "::error::unexpected characters in the hfp build args"; exit 1 ;;
+ esac
echo "BUILD_ARGS=$BUILD_ARGS"
echo "BUILD_ARGS=$BUILD_ARGS" >> $GITHUB_ENV
diff --git a/.github/workflows/build_util.yml b/.github/workflows/build_util.yml
index 02f16488a..407ed1e71 100644
--- a/.github/workflows/build_util.yml
+++ b/.github/workflows/build_util.yml
@@ -20,6 +20,10 @@ on:
required: false
default: ''
type: string
+ example-map:
+ required: false
+ default: ''
+ type: string
upload-artifacts:
required: false
default: false
@@ -76,19 +80,42 @@ jobs:
with:
arg: ${{ matrix.arg }}
+ - name: Resolve PR example filter
+ if: inputs.example-map != '' && inputs.example-map != '{}'
+ env:
+ # values are PR-derived - keep them out of ${{ }} script interpolation
+ # (env expansion word-splits but never re-parses shell metacharacters)
+ EXAMPLE_MAP: ${{ inputs.example-map }}
+ FAMILY: ${{ matrix.arg }}
+ run: |
+ # -e flags for this family; a family absent from the map builds everything
+ EX_ARGS=$(printf '%s' "$EXAMPLE_MAP" | jq -r --arg fam "$FAMILY" '(.[$fam] // []) | map("-e " + .) | join(" ")') || EX_ARGS=''
+ # the map's values are example dir names from the PR checkout, and `jq -r`
+ # un-escapes them: a path with a newline (git allows it) would otherwise write
+ # extra NAME=VALUE lines into GITHUB_ENV for every later step of this job.
+ # Anything outside the example-name alphabet drops the filter (= build all),
+ # which is the safe direction.
+ case "$EX_ARGS" in
+ *[!-A-Za-z0-9_/\ ]*)
+ echo "::warning::unexpected characters in the example filter - building all examples"
+ EX_ARGS='' ;;
+ esac
+ echo "EX_ARGS=$EX_ARGS"
+ echo "EX_ARGS=$EX_ARGS" >> $GITHUB_ENV
+
- name: Build
if: ${{ inputs.code-changed }}
env:
IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
run: |
if [ "${{ inputs.toolchain }}" == "esp-idf" ]; then
- docker run --rm -e MEMBROWSE_API_KEY="$MEMBROWSE_API_KEY" -e CI="$CI" -v $PWD:/project -w /project espressif/idf:tinyusb python tools/build.py --target all ${{ matrix.arg }}
+ docker run --rm -e MEMBROWSE_API_KEY="$MEMBROWSE_API_KEY" -e CI="$CI" -v $PWD:/project -w /project espressif/idf:tinyusb python tools/build.py --target all ${{ matrix.arg }} $EX_ARGS
else
BUILD_PY_ARGS="-s ${{ inputs.build-system }} ${{ steps.setup-toolchain.outputs.build_option }} ${{ inputs.build-options }} --target all"
if [ "${{ inputs.upload-metrics }}" = "true" ]; then
BUILD_PY_ARGS="$BUILD_PY_ARGS --target tinyusb_metrics"
fi
- python tools/build.py $BUILD_PY_ARGS ${{ matrix.arg }}
+ python tools/build.py $BUILD_PY_ARGS ${{ matrix.arg }} $EX_ARGS
fi
shell: bash
@@ -99,6 +126,9 @@ jobs:
MEMBROWSE_API_KEY: ${{ secrets.MEMBROWSE_API_KEY }}
run: |
# if code-changed is false --> there is no elf -> membrowse target upload with --identical flag
+ # deliberately unscoped by $EX_ARGS: keeps the size history on a stable board
+ # per family, at the cost of an --identical-only upload where that board is not
+ # the one the Build step picked (test_ci_metrics pins which families those are)
BUILD_PY_ARGS="-s ${{ inputs.build-system }} ${{ steps.setup-toolchain.outputs.build_option }} ${{ inputs.build-options }}"
python tools/build.py $BUILD_PY_ARGS --target examples-membrowse-upload -j 1 ${{ matrix.arg }}
shell: bash
@@ -108,13 +138,37 @@ jobs:
uses: actions/upload-artifact@v7
with:
name: metrics-${{ matrix.arg }}
- path: cmake-build/cmake-build-*/metrics.json
+ path: |
+ cmake-build/cmake-build-*/metrics.json
+ cmake-build/cmake-build-*/metrics_by_example.json
+
+ - name: Artifact name
+ if: inputs.upload-artifacts == true
+ env:
+ ARG: ${{ matrix.arg }}
+ run: |
+ # -e example filters carry '/', which upload-artifact forbids in artifact
+ # names; strip them from the NAME only (the build already consumed them).
+ # Names without -e stay byte-identical to before. Two entries differing
+ # only in their -e list cannot exist - the -e list is a function of
+ # (board), and variant suffixes (--build-name/-D/--cflag) survive the
+ # strip - so the stripped name is still unique per matrix entry.
+ TAG=$(printf '%s' "$ARG" | sed -E 's/ -e [^ ]+//g')
+ # board and example names come from the roster, which a PR can edit; a newline
+ # in one would write extra NAME=VALUE lines into GITHUB_ENV for every later
+ # step. There is no safe fallback name here - a wrong one mislabels the
+ # firmware the rig then flashes - so refuse instead.
+ case "$TAG" in
+ *[!-A-Za-z0-9_/\ .=+]*)
+ echo "::error::refusing to build an artifact name from '$ARG'"; exit 1 ;;
+ esac
+ echo "ARTIFACT_TAG=$TAG" >> $GITHUB_ENV
- name: Upload Artifacts for Hardware Testing
if: inputs.upload-artifacts == true && inputs.code-changed == true
uses: actions/upload-artifact@v7
with:
- name: binaries-${{ inputs.toolchain }}-${{ matrix.arg }}
+ name: binaries-${{ inputs.toolchain }}-${{ env.ARTIFACT_TAG }}
path: |
cmake-build/cmake-build-*/*/*/*.elf
cmake-build/cmake-build-*/*/*/*.bin