Publish releases to PyPI, and fix the README on the PyPI page - #90
Merged
Conversation
Trusted publishing, so no token is stored. The job checks the tag against the version in pyproject.toml, runs the tests, then builds and uploads.
PyPI resolves a relative image path against pypi.org, so both logos 404 there, and it prints a mermaid fence as source text. Point the pictures at absolute URLs and ship the flow as an SVG. The install line now leads with the tui extra.
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.
Two things left over from the 0.1.0 upload.
Release workflow:
Two steps are needed once this is merged, both outside the repo: register the trusted publisher on PyPI (owner KempnerInstitute, repo clustertool, workflow release.yml, environment pypi), and add required reviewers to the pypi environment.
README on PyPI:
Checked with readme_renderer, the library PyPI itself uses: no image resolves relative any more, and no mermaid source is left in the page. The new page reaches PyPI with the next release, since a description cannot be edited after upload.
Also worth knowing: the docs links in the README are still relative, so they lead nowhere from the PyPI page. Left alone for now, since that is every section of the file.