Skip to content

Make the release workflow a release check, and guard the README - #94

Merged
mmshad merged 3 commits into
mainfrom
release-check
Aug 6, 2026
Merged

Make the release workflow a release check, and guard the README#94
mmshad merged 3 commits into
mainfrom
release-check

Conversation

@mmshad

@mmshad mmshad commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Trusted publishing cannot work from this organization, so the exchange fails whatever the project is configured with. 0.1.1 went out by hand. Rather than keep a workflow that looks functional and is not, the publish step goes and the parts worth having stay.

The workflow, on a published release:

  • checks the tag against the version in pyproject.toml, which catches a tag without a bump
  • runs the tests and builds
  • attaches both artifacts to the release, which was a manual step before
  • no OIDC permission, no environment, no secret

CONTRIBUTING gains a release section with the steps: bump and lock, publish the release, then build and upload with a token that gets revoked afterward.

A guard for the thing that broke on the PyPI page:

  • every image in the README is served over an absolute URL, since PyPI resolves a relative path against pypi.org
  • the referenced files exist in the repository
  • no mermaid fence, since PyPI prints one as source text

Proven by mutation: making one image source relative again fails the first test. Note that twine check does not catch either problem, as it only asks whether a description renders, and the broken one rendered.

The pypi environment on the repo and the publisher registration on PyPI are left in place but dormant.

mmshad added 3 commits August 5, 2026 22:09
Trusted publishing cannot work from this organization, so the publish
step goes and the useful parts stay: the tag agrees with the version,
the tests pass, and both artifacts land on the release. Uploads are
manual now, and CONTRIBUTING says how and why.
Pictures are served over absolute URLs and there is no mermaid, since
PyPI resolves a relative path against pypi.org and prints a mermaid
fence as source text.
@mmshad
mmshad merged commit 47da434 into main Aug 6, 2026
7 checks passed
@mmshad
mmshad deleted the release-check branch August 6, 2026 02:23
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