ci: automate releases with Release Please#16
Open
KristianP26 wants to merge 5 commits into
Open
Conversation
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
Automates releases with Release Please: version bumps,
CHANGELOG.md, git tags, and GitHub Releases are driven by Conventional Commits, and the existing PyInstaller Windows build attaches its zip to each automated release.How it works
A single
release-please.ymlworkflow runs on push tomain:release-pleasejob (ubuntu) runsgoogleapis/release-please-action@v4, keeping a rolling Release PR up to date (version + changelog). Merging that PR creates the tag (vX.Y.Z) and a GitHub Release.buildjob (windows) runs only when a release was created (needs.release-please.outputs.release_created == 'true'): it checks out the tag, runs the test suite, builds with PyInstaller, and uploads the zip +.sha256viagh release upload.Keeping the build in the same workflow avoids the
GITHUB_TOKENlimitation (tags/releases created withGITHUB_TOKENdon't trigger separate workflows) — so no PAT is required.Changes
release-please-config.json(release-type: simple,include-component-in-tag: false→v{version}tags, changelog sections) and.release-please-manifest.jsonseeded to1.0.1(matches existingv1.0.0/v1.0.1tags)..github/workflows/release-please.yml; remove the old tag-triggered.github/workflows/release.yml(its build steps are migrated verbatim).Notes
mainafter merge.mainthe only commit sincev1.0.1is arefactor:, so the first Release PR appears once afeat/fixlands — expected Conventional Commits behaviour.@v4so thegithub-actionsDependabot entry keeps it current.