Skip to content

feat: release tooling (version bump, changelog, tag, GitHub release) #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JsNcAr merged 4 commits into from
Oct 12, 2026
Merged

feat: release tooling (version bump, changelog, tag, GitHub release) #17

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
494f08c
feat: release script with version bump, changelog and tag
BrahiamSSS Oct 12, 2026
9a86e07
ci: release workflow on v* tags, reusing the CI jobs
BrahiamSSS Oct 12, 2026
bfc899b
docs: releasing guide, and the release command in setup, index, READM…
BrahiamSSS Oct 12, 2026
ce5a086
chore: starter marker and changelog entry for the release tooling
BrahiamSSS Oct 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
chore: starter marker and changelog entry for the release tooling 
[tool.release] starter = true keeps the starter at 0.1.0: scripts/release.py
refuses to tag while it is set. The changelog header now says Unreleased
becomes the release notes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
  • Loading branch information
@BrahiamSSS @claude
BrahiamSSS and claude committed Oct 12, 2026
commit ce5a08688e953379826a535265f9354f12991c5c
10 changes: 9 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Changelog

Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Versions follow
`pyproject.toml`.
`pyproject.toml`. Add entries under **Unreleased** in the same pull request as
the change; `scripts/release.py` turns that section into the next release's
notes (see [docs/releasing.md](docs/releasing.md)).

## [Unreleased]

Expand Down Expand Up @@ -32,6 +34,12 @@ Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Versions follo
- `cryptography` 46.0.3 to 50.0.2, closing seven published advisories (#7).

### Added
- Release tooling: `scripts/release.py prepare patch|minor|major|X.Y.Z` runs
the suite, bumps `pyproject.toml`, turns Unreleased into the version's
section, commits, tags and pushes atomically; `.github/workflows/release.yml`
verifies the tag, reruns CI, builds the wheel and sdist and publishes the
GitHub release with that section as notes. The starter itself stays
unreleased behind `[tool.release] starter = true`; a clone flips it (#17).
- Logging configuration (`logging_config.py`): `LOG_LEVEL`, `LOG_FORMAT`
(`json` lines in production by default, `text` elsewhere), and a
QueueHandler/QueueListener pipeline from the standard library so that
Expand Down
5 changes: 5 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ dependencies = [
[tool.poetry]
packages = [{include = "basic_api", from = "src"}]

[tool.release]
# The starter is never released: scripts/release.py refuses while this is true.
# In a project built from it, set it to false once (docs/releasing.md).
starter = true


[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
Expand Down
Loading