Skip to content

Tag First 0.1.0 Release with CHANGELOG Entry #205

@jonathanMLDev

Description

@jonathanMLDev

Problem

The project has never cut a versioned release. setuptools-scm falls back to 0.1.0 because no git tags exist, and CHANGELOG.md contains only an [Unreleased] section. The review eval (Section 5.2) identifies this as one half of a deadlock: without a release boundary, there is no forcing function to resolve the dual collector base class (CollectorBase vs. AbstractCollector), and without resolving that, no release can meaningfully communicate API stability. Tagging 0.1.0 breaks the deadlock by establishing a baseline from which deprecations and migrations can be communicated.

Acceptance Criteria

  • CHANGELOG.md has a dated [0.1.0] section listing key features, known limitations, and the CollectorBase deprecation notice
  • A signed or annotated git tag v0.1.0 exists on the develop (or main) branch at the agreed commit
  • setuptools-scm resolves the version from the tag (no longer falls back to the hardcoded "0.1.0")
  • The CHANGELOG follows Keep a Changelog format with sections: Added, Changed, Deprecated, Fixed, Security
  • CollectorBase is listed under "Deprecated" with a note directing users to AbstractCollector

Implementation Notes

Run git tag -a v0.1.0 -m "Initial release" on the agreed commit. Verify with python -m setuptools_scm that the tag is picked up. The CHANGELOG entry should be honest about maturity — this is a "Promising" pre-production release, not a stability guarantee. The [Unreleased] items currently in CHANGELOG.md should be moved into the [0.1.0] section. Coordinate with Daniel (@snowfox1003) on the target commit, since his GCP staging deployment and collector base class work may need to land first. The pyproject.toml [tool.setuptools_scm] section's fallback_version can remain as a safety net.

References

  • Eval finding: Test 34 (Release Engineering)
  • Related files: CHANGELOG.md, pyproject.toml ([tool.setuptools_scm]), docs/Core_public_API.md (dual base class documentation)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions