🔧 build(release): adopt filelock-style automated workflow#420
Merged
gaborbernat merged 2 commits intotox-dev:mainfrom Feb 12, 2026
Merged
🔧 build(release): adopt filelock-style automated workflow#420gaborbernat merged 2 commits intotox-dev:mainfrom
gaborbernat merged 2 commits intotox-dev:mainfrom
Conversation
Migrate from tag-push to workflow_dispatch release process with automated changelog generation from git commit history. Changes: - Add tasks/changelog.py for generating changelog from git/GitHub API - Replace CHANGES.rst with docs/changelog.rst (full history) - Update release workflow to generate/commit changelog before tagging - Add release dependency group (gitpython, pygithub, pyyaml) - Add Sphinx extlinks for :pr:, :issue:, :user: roles - Update changelog URL to point to ReadTheDocs The new workflow allows triggering releases via GitHub Actions with semver bump selection (patch/minor/major), automatically extracts PR numbers and contributors from commits, and maintains changelog in the docs directory. Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
Type checking needs access to gitpython, pygithub, and pyyaml to resolve imports in tasks/changelog.py.
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
1 participant
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.
The previous release process required manually pushing git tags, which then triggered a simple build-and-publish workflow. This created friction for maintainers and made it difficult to track what changes were included in each release, since the changelog was maintained separately and often fell out of sync with actual releases.
This change adopts the release workflow pattern from
filelock, which automates changelog generation from git commit history. 🚀 When triggering a release via GitHub Actions, the workflow extracts PR numbers from commit messages, fetches contributor information from the GitHub API, generates formatted changelog entries, commits the updateddocs/changelog.rst, creates the git tag, and publishes to PyPI—all in a single workflow run. The changelog now lives in the Sphinx documentation and uses extlinks (:pr:,:user:) for proper cross-referencing.Maintainers can now trigger releases by selecting a semver bump level (patch/minor/major) in the GitHub Actions UI rather than manually tagging. ✨ The workflow is idempotent, checking for existing tags and releases to avoid conflicts. The historical
CHANGES.rsthas been migrated todocs/changelog.rstwith full version history from 2.0.0 onwards, ensuring continuity for users who reference the changelog.