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

Publish to Test PyPI fails #1102

Closed
ericwb opened this issue Jan 23, 2024 · 0 comments · Fixed by #1103
Closed

Publish to Test PyPI fails #1102

ericwb opened this issue Jan 23, 2024 · 0 comments · Fixed by #1103
Labels
bug Something isn't working
Milestone
Release 1.7.7

Comments

@ericwb
Copy link
Member

ericwb commented Jan 23, 2024

Describe the bug

When running the Publish to Test PyPI job, it fails with the following errors

https://github.com/PyCQA/bandit/actions/runs/7629885396/job/20784333526

Checking dist/bandit-1.7.7-py3-none-any.whl: FAILED
ERROR    `long_description` has syntax errors in markup and would not be        
         rendered on PyPI.                                                      
         line 115: Error: Unexpected indentation.                               
WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.   
Checking dist/bandit-1.7.7.tar.gz: FAILED
ERROR    `long_description` has syntax errors in markup and would not be        
         rendered on PyPI.                                                      
         line 115: Error: Unexpected indentation.                               
WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.

I suspect this is a result of markdown formatted text in the README which is RST format and used for the setuptools description.

Reproduction steps

1. Create a new release/tag for Bandit
2. Manually run the Publish to Test PyPI GitHub action
3. Notice the failure in the logs

Expected behavior

The action should run error free.

Bandit version

1.7.6 (Default)

Python version

3.12 (Default)

Additional context

No response
@ericwb ericwb added the bug Something isn't working label Jan 23, 2024
ericwb added a commit to ericwb/bandit that referenced this issue Jan 23, 2024
@ericwb
Remove markdown formatting in reStructuredText formatted README
8f78729 
A recent change to the README has code blocks in markdown format.
Since our README is actually reStructuredText format, this causes
syntax errors.

It's even bigger of a problem when an attempt to publish the package
with the README serving as the PyPI description. The syntax errors
prevents package publishing.

Fixes PyCQA#1102

Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
@ericwb ericwb mentioned this issue Jan 23, 2024
Merged
sigmavirus24 pushed a commit that referenced this issue Jan 23, 2024
@ericwb
Remove markdown formatting in reStructuredText formatted README (#1103)
3f86e84 
A recent change to the README has code blocks in markdown format.
Since our README is actually reStructuredText format, this causes
syntax errors.

It's even bigger of a problem when an attempt to publish the package
with the README serving as the PyPI description. The syntax errors
prevents package publishing.

Fixes #1102

Signed-off-by: Eric Brown <eric_wade_brown@yahoo.com>
@ericwb ericwb added this to the Release 1.7.7 milestone Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
Release 1.7.7
Development

Successfully merging a pull request may close this issue.

Remove markdown formatting in reStructuredText formatted README ericwb/bandit
1 participant
@ericwb