From 0c12bd4fcf0e1586ddbabd05a08c52efa37bc124 Mon Sep 17 00:00:00 2001 From: Jean-Pierre Martineau Date: Mon, 7 Sep 2026 12:25:03 -0400 Subject: [PATCH] Somewhere to download a build from MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pushing a version tag now builds the binaries and puts them on the Releases page, with a combined SHA256SUMS and notes lifted out of the changelog section for that version. It stays inside GitHub — while the repository is private the release is private too — and it is emphatically not the PyPI publish, which is `release.yml` and still needs a person to run it on purpose. `installers.yml` gained a `workflow_call` trigger so the release calls it instead of keeping a second copy of the matrix. Two matrices would agree for about a month and then quietly stop, and the files people download should be built exactly the way the ones CI checks on every push are. The README now leads its install section with the download rather than with pip, because most people who want MeshTerm have a radio and a terminal and not a Python toolchain. It also says plainly that the first launch will be blocked: these builds are unsigned, macOS will refuse them until the quarantine attribute is cleared, and Windows will show its SmartScreen warning. Signing costs real money on both platforms, so the honest move is to say so and give people the checksum file rather than let them think something is wrong. Co-Authored-By: Claude Opus 5 (1M context) --- .github/workflows/github-release.yml | 103 +++++++++++++++++++++++++++ .github/workflows/installers.yml | 3 + CHANGELOG.md | 3 + README.md | 30 ++++++-- 4 files changed, 134 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/github-release.yml diff --git a/.github/workflows/github-release.yml b/.github/workflows/github-release.yml new file mode 100644 index 0000000..37f9c48 --- /dev/null +++ b/.github/workflows/github-release.yml @@ -0,0 +1,103 @@ +# Puts the downloadable builds on the repository's Releases page. +# +# Nothing here leaves GitHub. While the repository is private the release is private too, +# visible and downloadable only by people who can see the repo. This is *not* the PyPI +# publish — that is `release.yml`, it is a separate act, and it does not run from here. +# +# Triggered by pushing a version tag, which is the moment a release exists in git anyway: +# +# git tag -a v0.3.0 -m "MeshTerm 0.3.0" +# git push origin v0.3.0 +# +# The binaries are built by `installers.yml`, called rather than copied, so the files +# people download are made exactly the way the ones CI checks on every push are. +name: GitHub release + +on: + push: + tags: ["v*"] + workflow_dispatch: + inputs: + tag: + description: "Existing tag to build a release from (e.g. v0.2.0)" + required: true + type: string + prerelease: + description: "Mark as a pre-release (keeps it out of 'Latest')" + type: boolean + default: false + +permissions: + contents: read + +jobs: + build: + uses: ./.github/workflows/installers.yml + + publish: + name: create the release + needs: build + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + # The one job that needs it: creating a release writes to the repository. + contents: write + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ inputs.tag || github.ref }} + + # Every platform's artifact, flattened into one directory of files to attach. + - uses: actions/download-artifact@v4 + with: + path: artifacts + merge-multiple: true + + - name: Gather the binaries and their checksums + id: gather + shell: bash + run: | + mkdir -p release + find artifacts -type f -exec mv {} release/ \; + ls -lh release/ + # One combined checksum file is easier to verify against than five loose ones. + (cd release && cat *.sha256 > SHA256SUMS && rm -f *.sha256) + tag="${{ inputs.tag || github.ref_name }}" + echo "tag=$tag" >> "$GITHUB_OUTPUT" + echo "version=${tag#v}" >> "$GITHUB_OUTPUT" + + - name: Take the release notes from the changelog + id: notes + shell: bash + env: + VERSION: ${{ steps.gather.outputs.version }} + run: | + # The section for this version, between its own heading and the next one. If the + # changelog has nothing for it, say so plainly rather than inventing notes. + if awk -v v="$VERSION" ' + $0 ~ "^## \\[" v "\\]" {found=1; next} + found && /^## \[/ {exit} + found {print} + ' CHANGELOG.md | sed '/^$/d' | head -1 | grep -q .; then + awk -v v="$VERSION" ' + $0 ~ "^## \\[" v "\\]" {found=1; next} + found && /^## \[/ {exit} + found {print} + ' CHANGELOG.md > notes.md + else + echo "No changelog entry for $VERSION." > notes.md + fi + echo "--- notes ---"; cat notes.md + + - name: Create it + env: + GH_TOKEN: ${{ github.token }} + TAG: ${{ steps.gather.outputs.tag }} + PRERELEASE: ${{ inputs.prerelease && '--prerelease' || '' }} + run: | + gh release create "$TAG" release/* \ + --title "MeshTerm ${TAG#v}" \ + --notes-file notes.md \ + --verify-tag \ + $PRERELEASE + echo "https://github.com/${{ github.repository }}/releases/tag/$TAG" diff --git a/.github/workflows/installers.yml b/.github/workflows/installers.yml index c102c9f..61d6c04 100644 --- a/.github/workflows/installers.yml +++ b/.github/workflows/installers.yml @@ -11,6 +11,9 @@ 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. Three operating systems is not something to # spend on every commit while the repository is private and minutes are metered. push: diff --git a/CHANGELOG.md b/CHANGELOG.md index 4beaac7..be37379 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,6 +38,9 @@ allowed to change behaviour, not just add to it. it on purpose and types the version. - A security policy, a code of conduct, issue and pull request templates, weekly dependency updates, and the funding links the app's own support page already offers. +- A Releases page. Pushing a version tag builds the binaries and attaches them, with a + combined `SHA256SUMS` and release notes taken from this file. It stays inside GitHub + and is not the PyPI publish, which remains a separate and deliberate act. - Standalone builds. A PyInstaller spec and a workflow that builds a single runnable file for Windows, macOS (Intel and Apple silicon) and Linux (x64 and ARM64), checks each one runs from outside the source tree, and writes a checksum beside it. Nothing diff --git a/README.md b/README.md index 2b675d1..f084eb9 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ your mesh's history is worth. License: Apache-2.0 For MeshCore Interface: TUI + CLI + Download Discord

@@ -54,6 +55,28 @@ your mesh's history is worth. ## Install +### Download a build + +**[⬇ Latest release](https://github.com/jpmartineau/MeshTerm/releases/latest)** — one file, +no Python needed. Windows, macOS (Apple silicon) and Linux (x64 and ARM64, so the uConsole +is covered). + +Download it, make it runnable, and run it: + +```bash +chmod +x meshterm-* # macOS and Linux only +./meshterm-* +``` + +> **Your system will complain the first time.** These builds aren't code-signed — signing +> costs money on both platforms and this is a free side project. macOS says *"cannot be +> opened because the developer cannot be verified"*; clear it with +> `xattr -d com.apple.quarantine meshterm-*` and run it again. Windows shows *"Windows +> protected your PC"*; click **More info → Run anyway**. Each release ships a `SHA256SUMS` +> file if you'd rather check the download yourself. + +### Or install with pip + You need **Python 3.10 or newer**. That's the only requirement — MeshTerm pulls in everything else itself. @@ -76,11 +99,8 @@ can have a look around before you buy anything. ### Coming -- **Downloadable installers** for Windows, macOS and Linux, so you won't need Python at - all. They'll show up on the [Releases](https://github.com/jpmartineau/MeshTerm/releases) - page. -- **`pip install mesh-term`**, once the package is published. It isn't yet — the name - question is still being sorted out ([why](https://github.com/pypi/support/issues/12162)). +**`pip install mesh-term`**, once the package is published. It isn't yet — the name +question is still being sorted out ([why](https://github.com/pypi/support/issues/12162)). Setting up for development instead? That's in [CONTRIBUTING.md](CONTRIBUTING.md).