The five installers bundled Cascadia's font licence and nothing else -- not MeshTerm's own LICENSE and NOTICE, not the MIT/BSD/PSF notices Apache-2.0 and those licences all want kept with a redistributed copy. packaging/notices.py walks the mesh-term distribution's actual runtime dependency closure through importlib.metadata (markers evaluated for this platform, the dev extra excluded), gathers each package's licence text, and fails the build loudly if one is missing rather than shipping a silent gap -- which is exactly what it found: pyserial and the nine winrt-* packages bleak's Windows backend pulls in all declare a licence but ship no licence file in their wheel at all. Their real text, pulled from each project's own repository, is vendored under packaging/vendored-licenses/ for those two documented, verified gaps; anything else missing still stops the build. The spec generates THIRD-PARTY-NOTICES.txt fresh into the build directory on every run and bundles it at the archive root alongside LICENSE and NOTICE. installers.yml uploads the same three files once, from the linux-x64 leg, so they land beside the downloads on the release page too, without extracting an installer just to read them. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
141 lines
6.3 KiB
YAML
141 lines
6.3 KiB
YAML
# Standalone builds — a single file you download and run, with no Python installed.
|
|
#
|
|
# For most people who want MeshTerm, this is the install. They have a radio and a
|
|
# terminal, not a Python toolchain.
|
|
#
|
|
# Frozen builds cannot be cross-compiled: each one is made on the system it targets, so
|
|
# the matrix is the point of this file rather than an optimisation. Everything here
|
|
# uploads artifacts and nothing publishes — attaching them to a release stays a separate,
|
|
# deliberate act.
|
|
name: Installers
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
# Callable, so the release workflow builds these binaries rather than keeping a second
|
|
# copy of the matrix that would drift from this one.
|
|
workflow_call:
|
|
# Only when the packaging itself changes. A five-platform build takes the better part
|
|
# of half an hour, and a commit that touched nothing it freezes has nothing to learn
|
|
# from one; the release build is what proves the binaries.
|
|
push:
|
|
# `main` only. Without this, every Dependabot branch that touches this file — which
|
|
# is every action bump — starts a five-platform build of its own.
|
|
branches: [main]
|
|
paths:
|
|
- "packaging/**"
|
|
- ".github/workflows/installers.yml"
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: installers-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
name: ${{ matrix.label }}
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 25
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- { os: windows-latest, label: windows-x64, ext: ".exe" }
|
|
- { os: macos-latest, label: macos-arm64, ext: "" }
|
|
# Apple silicon builds do not run on Intel Macs, and plenty of people still
|
|
# have one. `macos-15-intel` rather than `-26-intel` for the same reason the
|
|
# Python here is 3.10: built against an older system, runs on more machines.
|
|
# (Not `macos-13` — that image is retired, and a job asking for it does not
|
|
# fail, it queues forever and holds the whole run open behind it.)
|
|
- { os: macos-15-intel, label: macos-x64, ext: "" }
|
|
- { os: ubuntu-22.04, label: linux-x64, ext: "" }
|
|
# For the uConsole and other 64-bit ARM handhelds. The ARM runners are the
|
|
# public-repository ones; a private fork of this file may find the leg sits
|
|
# unclaimed, and can drop the line.
|
|
- { os: ubuntu-22.04-arm, label: linux-arm64, ext: "" }
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
# Oldest supported version on purpose: a binary built against an older glibc
|
|
# and an older Python runs on more machines than one built against the newest.
|
|
python-version: "3.10"
|
|
|
|
- run: pip install . pyinstaller
|
|
|
|
- name: Build
|
|
working-directory: packaging
|
|
run: pyinstaller --clean --noconfirm meshterm.spec
|
|
|
|
# `packaging/meshterm.spec` regenerates `THIRD-PARTY-NOTICES.txt` fresh on every
|
|
# leg's own build (see `packaging/notices.py`) and bundles it, along with LICENSE
|
|
# and NOTICE, inside that leg's own installer -- so each downloaded binary always
|
|
# carries an accurate copy of what it actually contains. This step is a separate
|
|
# convenience: the same three files land on the release page itself, next to the
|
|
# downloads, so nobody has to extract an installer just to read a license. One
|
|
# copy serves every platform there (LICENSE/NOTICE never vary, and the runtime
|
|
# dependency closures differ only in a handful of platform-specific packages), so
|
|
# it rides on this leg alone rather than being uploaded -- and attached to the
|
|
# release -- five identical-in-substance times over. linux-x64 was picked
|
|
# arbitrarily among the five; nothing here is Linux-specific.
|
|
- name: Upload the licences for the release page
|
|
if: matrix.label == 'linux-x64'
|
|
shell: bash
|
|
run: |
|
|
# `build/<specname>/` is PyInstaller's own workpath layout (see the spec's
|
|
# comment on `workpath`), not something worth this step knowing by heart
|
|
# twice -- copy it flat, next to LICENSE and NOTICE, so the artifact (and,
|
|
# via `find`, the release assets built from it) is three plain files.
|
|
cp packaging/build/meshterm/THIRD-PARTY-NOTICES.txt .
|
|
|
|
- uses: actions/upload-artifact@v4
|
|
if: matrix.label == 'linux-x64'
|
|
with:
|
|
name: meshterm-licenses
|
|
path: |
|
|
LICENSE
|
|
NOTICE
|
|
THIRD-PARTY-NOTICES.txt
|
|
if-no-files-found: error
|
|
|
|
- name: Check it actually runs
|
|
shell: bash
|
|
run: |
|
|
bin="packaging/dist/meshterm${{ matrix.ext }}"
|
|
chmod +x "$bin" || true
|
|
# Run it from somewhere else entirely, so a build that only works next to the
|
|
# source tree fails here rather than on someone's laptop.
|
|
cd "$(mktemp -d)"
|
|
"$GITHUB_WORKSPACE/$bin" --help > /dev/null
|
|
# Reads the asset files, so a bundle missing its pages fails here.
|
|
"$GITHUB_WORKSPACE/$bin" specimen > /dev/null
|
|
# And a tool-provided subcommand, which is the check that matters. Every tool is
|
|
# found at runtime by `pkgutil.iter_modules`, so a bundle that omits them still
|
|
# starts, still prints help, still draws the specimen — and has an empty menu
|
|
# with nothing in it but Quit. `--help` passing proves almost nothing on its own.
|
|
"$GITHUB_WORKSPACE/$bin" contacts --help > /dev/null
|
|
echo "runs, finds its assets, and its tools registered"
|
|
|
|
- name: Name it after the version and the platform
|
|
shell: bash
|
|
run: |
|
|
version=$(python -c "import meshterm; print(meshterm.__version__)")
|
|
out="meshterm-${version}-${{ matrix.label }}${{ matrix.ext }}"
|
|
mv "packaging/dist/meshterm${{ matrix.ext }}" "$out"
|
|
# A checksum beside the binary, so anyone can tell they got what we built.
|
|
if command -v sha256sum > /dev/null; then
|
|
sha256sum "$out" > "$out.sha256"
|
|
else
|
|
shasum -a 256 "$out" > "$out.sha256"
|
|
fi
|
|
cat "$out.sha256"
|
|
|
|
- uses: actions/upload-artifact@v4
|
|
with:
|
|
name: meshterm-${{ matrix.label }}
|
|
path: |
|
|
meshterm-*
|
|
if-no-files-found: error
|