Skip to content

Bump to v1.0.0 (first stable release; metadata maintenance)#9

Merged
mstorath merged 1 commit into
masterfrom
claude/maintenance-release-2026-05
May 11, 2026
Merged

Bump to v1.0.0 (first stable release; metadata maintenance)#9
mstorath merged 1 commit into
masterfrom
claude/maintenance-release-2026-05

Conversation

@mstorath

Copy link
Copy Markdown
Owner

Summary

Phase 3 maintenance release for dcebe — promotes from 0.1.0 to 1.0.0 to signal API stability. No algorithmic changes; the user-facing API (estimate_bat) is unchanged from the 0.1.0 dev release.

Aligns all release-version surfaces:

  • pyproject.toml::version1.0.0
  • python/dcebe/__init__.py::__version__"1.0.0"
  • CITATION.cffversion: 1.0.0, date-released: 2026-05-11
  • CHANGELOG.md → created (was missing from the repo) with the [1.0.0] — 2026-05-11 entry

What landed in this version

  • README rewritten and harmonised (Pass F) — the previous README was MATLAB-only.
  • LICENSE cleaned up: non-standard "if this code is used in any scientific publication, the following paper shall be cited" clause removed. The LICENSE file is now pure Apache-2.0 matching the SPDX declaration in CITATION.cff and pyproject.toml; the citation request lives in CITATION.cff and the README.
  • CITATION.cff version/date-released fields populated (Pass A).
  • Auto-create GitHub Release on tag push wired up.

After merge

Tag v1.0.0 on the merge commit and push the tag. The auto-release workflow handles PyPI publish + GitHub Release creation.

Test plan

  • Release workflow runs to completion on tag push
  • PyPI shows dcebe 1.0.0 with the harmonised README rendering correctly
  • from dcebe import estimate_bat works from the published wheel
  • GitHub's license-detector identifies the repo as Apache-2.0 cleanly

Promotes dcebe to 1.0.0 to signal API stability. The MATLAB reference
implementation has been published since 2018; the Python port was
developed in 2026 and the public API (estimate_bat) is unchanged
from the 0.1.0 dev release.

Aligns pyproject.toml, python/dcebe/__init__.py __version__, and
CITATION.cff version/date-released. Adds CHANGELOG.md (was missing).
No algorithmic changes.
@mstorath mstorath merged commit 800c3d8 into master May 11, 2026
5 checks passed
@mstorath mstorath deleted the claude/maintenance-release-2026-05 branch May 11, 2026 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant