Versioned docs + release workflow revamp (#47, #39) - #48
Merged
Conversation
Deploy MkDocs with mike only after a successful PyPI publish (separate workflow), migrate History.md into docs/release-notes.md, and auto-fill missing release-note sections from merged PRs on tag publish. Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
Docs check
|
…test dedup - docs/release-notes.md gains an Unreleased section maintained per PR - changelog.yml enforces an Unreleased entry per PR (skip-changelog label bypass) - scripts/prepare_release.py cuts releases locally (bump + rename Unreleased); removes PR-scraping generator - publish.yml is verify-only (no file mutation, contents: read) and checks that release notes were prepared - docs.yml deploys from the tagged release commit, not master - extract reusable tests.yml called by CI and publish, gating publish (#39) Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
cursor
Bot
changed the title
Satisfy the new changelog check by recording the user-facing docs and release-flow changes introduced in #48. Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
ilouzl
marked this pull request as ready for review
July 28, 2026 08:53
Build and validate the cut changelog in memory first, then write __version__.py and release-notes.md. A failed Unreleased check no longer leaves a half-applied version bump. Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
Contributor
Author
Closed
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
2 participants
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
Aligns published docs with PyPI releases (#47) and deduplicates the test matrix (#39).
Release model: author-written changelog + prep-commit-then-tag + verify-only pipeline.
Per PR
## Unreleasedindocs/release-notes.mdchangelog.ymlfails the PR if noUnreleasedentry was added; bypass with theskip-changeloglabelVerify docsandCIstill runReleasing (local, then tag)
scripts/prepare_release.py X.Y.Zbumpstapsdk/__version__.pyand renamesUnreleased -> X.Y.Z (date), opening a freshUnreleasedvX.Y.Z, and pushTag pipeline (verify-only)
publish.ymlno longer mutates files or pushes tomaster(contents: read). It re-runs tests, validates the tag vs__version__, verifies the release-notes section exists andUnreleasedis empty, then builds + publishes to PyPIdocs.ymldeploys mike-versioned docs from the tagged release commit after a successful publish, so tag/PyPI/docs all agreeTest dedup (#39)
tests.yml(workflow_call) holds the single lint + OS x Python matrixtest.yml(CI) and thetestjob inpublish.ymlboth call it;publishstays gated ontestMaintainer follow-up (one-time)
gh-pages/(root)skip-changeloglabelTest plan
mkdocs build --strictprepare_release.pydry behavior: refuses emptyUnreleased, cuts a versioned section otherwiseflake8clean on new scripts; all workflow YAML parsesvX.Y.Ztag publishes and deploys versioned docs