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.

Sign up for GitHub

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

Jump to bottom

Fail upload if rST description does not render #3966

Closed
di opened this issue May 14, 2018 · 5 comments
Closed

Fail upload if rST description does not render #3966

di opened this issue May 14, 2018 · 5 comments
Labels
feature request

Comments

@di
Copy link
Member

di commented May 14, 2018

If the reStructuredText long_description does not render, let's fail the upload instead of just rendering it as plaintext, and raise a meaningful error to the user.
@di
Copy link
Member Author

di commented May 14, 2018

cc @mblayman

@theacodes
Copy link
Contributor

#3760 should help - you can call warehouse.utils.readme.render to check and see if the description is valid.

mblayman added a commit to mblayman/warehouse that referenced this issue May 14, 2018
@mblayman
Fail to upload package when description rendering is invalid.
ee493a6 
This branch prevents a package upload if the rendered content for the
description_content_type is invalid. If no description_content_type is
set, 'text/x-rst' is assumed as the type.

Fixes pypi#3966
@mblayman mblayman mentioned this issue May 14, 2018
Merged
@dstufft
Copy link
Member

dstufft commented Jul 12, 2018

Reopening this since the change got reverted.

@dstufft dstufft reopened this Jul 12, 2018
@di
Copy link
Member Author

di commented Jul 12, 2018

Looking at the user's project and their Travis build logs in #4099, I can't see why the upload would have failed.

We should probably experiment with this Travis feature and figure out if it was somehow user error, or if there's actually something broken about the way Travis deploys to PyPI.

@dstufft
Copy link
Member

dstufft commented May 12, 2019

Solved in #5835

@dstufft dstufft closed this as completed May 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dstufft @theacodes @di