Fix: 'long_description' error when publishing to PyPI - Githubissues

Yelp / fuzz-lightyear

A pytest-inspired, DAST framework, capable of identifying vulnerabilities in a distributed, micro-service ecosystem through chaos engineering testing and stateful, Swagger fuzzing.

Other

212 stars 26 forks source link

Fix: 'long_description' error when publishing to PyPI #92

Closed Chandra158 closed 9 months ago

Chandra158 commented 9 months ago

Overview

Publish to PyPI workflow fails with below error:

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

Although, we don't have long_description field in setup.py, workflow fails
Some discussions have suggested to add long_description_content_type to fix this error
- https://github.com/pypa/gh-action-pypi-publish/discussions/191
- https://github.com/pypa/gh-action-pypi-publish/discussions/209
Adding long_description field along with content_type for better description in the pypi project page