catarrh
aa8c9c6f12
release / release (push) Waiting to run
Reinstalling the package was slow because setup rebuilds pysim's prerequisites (pyscard compiles from source on Linux), while a clone updates with a plain `git pull`. - tools/update.py (+ update.sh / update.bat in the package, and the release workflow shipping them) updates a packaged install in place: it downloads the latest release package, extracts it (zip-slip guard, permission bits restored - zipfile drops them), replaces the app files over the app directory and re-installs the app into the existing .venv. The .venv and simple_lastrun.log are not in the package, so pysim and its prerequisites survive: seconds, not a rebuild. --check / --version / --zip (offline) / --no-pip / --force; the same version is a no-op. - CHANGELOG.md (Keep a Changelog, from the first packaged release; earlier history is the git log). The release workflow now uses the version's CHANGELOG section as the release body (tools/changelog_section.py, falling back to generated notes). - The READMEs document the update path and the `git clone --depth 1` option for the clone path; setup prints the update hint. - Version strings + the PWA cache bumped together (simple-v458). Verified: 1007 Python + 953 frontend; the release-package test covers the new files; the updater was exercised end to end (a v3.31.2 install with a real venv updated to the 3.32.0 package: files replaced, the venv marker kept, pip metadata 3.32.0, exec bits kept, a second run a no-op, --check correct).
96 lines
3.2 KiB
YAML
96 lines
3.2 KiB
YAML
name: release
|
|
|
|
# Builds the release package from the tagged source and publishes it.
|
|
# The package is a snapshot of the tree without the development-only files
|
|
# (tools/build_release.py); pysim is not bundled - setup installs it from
|
|
# upstream. Trigger: push a v* tag (or run manually for an existing tag).
|
|
|
|
on:
|
|
push:
|
|
tags: ['v*']
|
|
workflow_dispatch:
|
|
inputs:
|
|
tag:
|
|
description: 'Tag to package and publish (e.g. v3.31.0)'
|
|
required: true
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
release:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Check out the tagged source
|
|
uses: actions/checkout@v4
|
|
with:
|
|
path: simple
|
|
ref: ${{ github.event.inputs.tag || github.ref }}
|
|
|
|
# The Python tests expect a pysim checkout as a sibling of the repo
|
|
# (tests/*.py prepend <repo>/../pysim to sys.path).
|
|
- name: Check out pysim next to the repo
|
|
uses: actions/checkout@v4
|
|
with:
|
|
repository: osmocom/pysim
|
|
path: pysim
|
|
|
|
# 3.13+ is required by the suite: ssl's TLS-PSK callbacks
|
|
# (SCP81's PskTlsServer) exist only since Python 3.13.
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.13'
|
|
|
|
# pyscard has no manylinux wheels, so it builds from source on Linux
|
|
# and needs the PC/SC development headers.
|
|
- name: Install the PC/SC development headers
|
|
run: sudo apt-get update && sudo apt-get install -y libpcsclite-dev
|
|
|
|
- name: Install pysim and the test dependencies
|
|
working-directory: simple
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
python -m pip install -r requirements-pysim.txt
|
|
python -m pip install --no-deps ../pysim
|
|
|
|
- name: Python suite
|
|
working-directory: simple
|
|
run: python -m unittest discover -s tests
|
|
|
|
# sp.test.js / the AES tests require the npm runtime dependencies
|
|
# (des.js, aes-js); the build deps come along with them.
|
|
- name: Install the frontend test dependencies
|
|
working-directory: simple/frontend
|
|
run: npm ci --no-audit --no-fund
|
|
|
|
- name: Frontend suite
|
|
working-directory: simple/frontend
|
|
run: node --test
|
|
|
|
- name: Build the release package
|
|
working-directory: simple
|
|
run: |
|
|
TAG="${{ github.event.inputs.tag || github.ref_name }}"
|
|
python tools/build_release.py --expect-version "${TAG#v}" --out dist
|
|
|
|
- name: Publish the release
|
|
working-directory: simple
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
run: |
|
|
TAG="${{ github.event.inputs.tag || github.ref_name }}"
|
|
VER="${TAG#v}"
|
|
ZIP="dist/simple-$VER.zip"
|
|
# The release body is the CHANGELOG section of the version; a missing
|
|
# section falls back to generated notes.
|
|
if python tools/changelog_section.py "$VER" > /tmp/notes.md 2>/dev/null; then
|
|
NOTES="--notes-file /tmp/notes.md"
|
|
else
|
|
NOTES="--generate-notes"
|
|
fi
|
|
if gh release view "$TAG" >/dev/null 2>&1; then
|
|
gh release upload "$TAG" "$ZIP" --clobber
|
|
else
|
|
gh release create "$TAG" "$ZIP" --title "$TAG" $NOTES
|
|
fi
|