Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix pypi push by specifying a long_description #1051

Merged
merged 2 commits into from Dec 17, 2022
Merged

Conversation

achantavy
Copy link
Contributor

@achantavy achantavy commented Dec 16, 2022

Pypi publish has been breaking since 0.67.0: https://github.com/lyft/cartography/actions/runs/3716067385/jobs/6301965332.

The error message was

ERROR    `long_description` has syntax errors in markup and would not be rendered on PyPI.
         No content rendered from RST source.

Repro

I searched and found a hint in pypa/twine#454. I was able to reproduce the error locally by installing twine (at 4.0.2) with pip install twine, building a dist with python -m pip install build && python -m build --sdist --wheel --outdir dist/ ., and then running twine check dist/*.

Fix

I added a long_description field to setup.py and re-ran twine and it passed:
image

I'm not sure if long_description is now mandatory, but at this point I just want my release to stop breaking and to be published to pypi.

I've also filed pypa/twine#960.

@achantavy achantavy merged commit 225e01f into master Dec 17, 2022
@achantavy achantavy deleted the longdescription branch December 17, 2022 00:24
WannabeSmith added a commit to WannabeSmith/nprr that referenced this pull request May 18, 2023
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.

None yet

2 participants