Repository navigation
ci: release with release-please, as in port-bridge - #3
Merged
Merged
Conversation
Replace the tag-driven release (setuptools-scm) by release-please: the version is static in pyproject.toml and bumped by the release PR, merging it creates the tag and the GitHub release, and release-please.yml then uploads the sdist/wheel (release.yml), builds the installers (build-installers.yml) and publishes to PyPI from the top-level workflow, which is the trusted publisher (workflow release-please.yml, environment pypi). CONTRIBUTING describes the commit convention and the one-time setup. feat: ad3-bench-server shares the WaveForms library over TCP; RemoteDwfApi, AnalogDiscovery3(remote=...), AD3_REMOTE and --ad3-remote use it feat: ad3-bench-gui, a PySide6 GUI for the server, with a Windows installer and a Linux AppImage feat: FirmwareTerminal accepts pyserial URLs such as socket:// for serial ports forwarded by port-bridge build: type information (py.typed), mypy and coverage in CI, tests on Linux, Windows and macOS with Python 3.10-3.14 Release-As: 0.2.0 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TPQkhNKUR1hxzoycY8R9VV
# Conflicts: # .github/workflows/ci.yml # .github/workflows/release.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the tag-driven release (setuptools-scm) with release-please, set up the same way as in port-bridge.
How a release works after this PR:
mainrunsrelease-please.yml. It opens or updates achore(main): release X.Y.Zpull request, which bumpsversioninpyproject.tomland the manifest and adds the notes toCHANGELOG.md.vX.Y.Ztag and the GitHub release. The same run then:release.ymlbuilds the sdist and wheel, checks the version against the tag, and attaches the files to the release.build-installers.ymlbuilds the Windows installer and the Linux AppImage and attaches them.publishuploads to PyPI with trusted publishing.release-please.ymlbecause PyPI identifies the top-level workflow, as in port-bridge.release-please.yml, environmentpypi.Changes
0.1.0inpyproject.tomland managed by release-please. setuptools-scm is removed.release-please-config.jsonand.release-please-manifest.json. They're the same as port-bridge's (python release type,extra-filesfor the pyproject version), apart from the package name..github/workflows/release-please.ymlwith the jobsrelease-please→release+installers, thenpublish.release.yml: now started byrelease-please.ymlor by hand withtag_name(to backfill a tag); it no longer runs on a pushed tag. It builds the package files and attaches them to the existing release.build-installers.yml/ci.yml:fetch-depth: 0is gone; only setuptools-scm needed it.CHANGELOG.md: now in release-please format. The hand-written Unreleased notes move into the seed commit, described below.CONTRIBUTING.md: documents the commit convention, the release flow and the one-time setup. The README links to it.First release: 0.2.0
The commit message of this PR carries extra Conventional Commit entries (
feat:for the remote server, the GUI and URL ports, and abuild:entry) plusRelease-As: 0.2.0. release-please reads several entries from one commit message, so the first release PR is 0.2.0, with those features in its notes.➡️ Merge with a merge commit or a rebase, not a squash. Otherwise those footer lines may not reach
main.One-time setup (also in CONTRIBUTING.md)
ad3-waveforms-bench, ownerembedded-pro, repositoryad3-waveforms-bench, workflowrelease-please.yml, environmentpypi.pypi, optionally with required reviewers.RELEASE_PLEASE_TOKENsecret (a fine-grained token with Contents and Pull requests read/write access). PRs opened withGITHUB_TOKENdon't trigger CI.Testing
ruff check,ruff format --checkandmypyare clean. 137 tests pass (GUI tests run offscreen), with 85% coverage.python -m buildproducesad3_waveforms_bench-0.1.0(sdist and wheel), andtwine check --strictpasses.v0.1.0, and the installed wheel reports__version__ == "0.1.0".release-pleaserun onmainshould openchore(main): release 0.2.0with the seeded features.🤖 Generated with Claude Code
https://claude.ai/code/session_01TPQkhNKUR1hxzoycY8R9VV
Generated by Claude Code