ci: add release-please for automated per-package versioning - #5
Merged
Conversation
Manifest mode, one component per releasable package (the 5 xknx-* libraries plus knx-gui), each with its own version, CHANGELOG.md, git tag, and GitHub Release. release-type is python (bumps [project].version in pyproject.toml). separate-pull-requests keeps each package's release independent. bump-minor-pre-major keeps breaking changes on 0.x versions from jumping straight to 1.0.0. Manifest baseline is 0.0.0 for every component, since none of them have actually shipped a release yet - the first real release lands wherever the conventional commits merged after bootstrap-sha add up to.
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
release-please-config.json+.release-please-manifest.json+.github/workflows/release-please.ymlfor automated version bumping, changelog generation, and GitHub Releases per packagexknx-*libraries (packages/*) plusknx-gui(apps/knx-gui), eachrelease-type: python(bumps[project].versionin itspyproject.toml)separate-pull-requests: true— each package gets its own release PR and its own tag/release (<component>-v<version>), independent timingbump-minor-pre-major: true— a breaking change (feat!:/fix(scope)!:) on a 0.x package stays in the 0.x range instead of jumping straight to 1.0.00.0.0for every component — none of them have actually shipped a release yet (see docs: mark all changelogs unreleased, add changelog-format CI check #3), so the first real release lands wherever the conventional commits merged afterbootstrap-shaadd up toGITHUB_TOKEN(no new secrets needed) — the one tradeoff is release-please's own generated PRs won't trigger otherpush/pull_requestworkflows (GitHub's anti-recursion rule), but the repo ruleset doesn't require status checks to merge, so this doesn't block anythingDepends on
Test plan
feat:/fix:PR lands for a given package