chore: fix distro README metadata and release 0.3.1 - #51
Merged
Conversation
The dash0-opentelemetry title overline/underline were 18 chars for a 19-char title, so twine check --strict rejected the wheel long_description and the v0.3.0 release build failed before anything was published. Fix the underlines, bump the distro to 0.3.1 (v0.3.0's tag is burned and immutable), and add twine check --strict to the CI build job so a long_description that would fail at publish time is caught on every PR instead.
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.
Why
The
v0.3.0release build failed atbuild → Validate package metadata: the distro'sREADME.rsttitledash0-opentelemetry(19 chars) had an 18-char===overline/underline, sotwine check --strictrejected the wheel'slong_description("would not render on PyPI"). Nothing was published, but thev0.3.0tag is now immutable (ruleset), so the fix ships as 0.3.1.What
README.rst— overline/underline → 19 chars. Verified the built wheel + sdist now passtwine check --strict.0.3.0→0.3.1and repurpose the (empty, never-shipped)0.3.0changelog section.uv.lockneeds no change (the distro is an editable workspace source with no pinned version).twine check --stricttoci.yml'sbuildjob so along_descriptionthat would fail at publish time is caught on every PR — this class of error previously reachedmainbecause CI only did a build smoke-test.Release
After merge, push the
v0.3.1tag →release.ymlbuilds all five packages (distro0.3.1, vendored1.44.0.post1— none indexed yet, so all five publish) and publishes to PyPI + the index, pausing at the fivepypi-*environment gates for approval.