Skip to content

Add a readme_renderer check to build.yml #61

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

Closed
siddacious opened this issue Jan 11, 2020 · 3 comments
Closed

Add a readme_renderer check to build.yml #61

siddacious opened this issue Jan 11, 2020 · 3 comments
Assignees

Comments

@siddacious
Copy link
Contributor

siddacious commented Jan 11, 2020

I ran into an issue with Adafruit_CircuitPython_ICM20649 :
adafruit/Adafruit_CircuitPython_ICM20X#1
An issue with the parsing of the README.rst was preventing it from getting uploaded to PyPi. The symptom was a failing "Release Actions" -> "upload-pypi" job with this error:

image

The included URL pointed me to docs that lead me to the 'readme_parser' module that PyPi users. I was able to test with:

pip install --user --upgrade setuptools wheel twine readme_renderer
python setup.py sdist
python setup.py bdist_wheel --universal
twine check dist/*
@siddacious siddacious changed the title Add a readme_parser check to build.yml Add a readme_renderer check to build.yml Jan 13, 2020
@evaherrada
Copy link
Collaborator

Might also need to install testresources, I did when I installed this

@makermelissa
Copy link
Collaborator

It seems like this step conflicts with the release.yml in that it checks for a file named setup.py to determine if it should upload to PyPI, but without setup.py here it fails build.yml.

@evaherrada
Copy link
Collaborator

@makermelissa oh yeah, I completely overlooked that. I'll make a pr wtih a fix soon.

@evaherrada evaherrada self-assigned this Sep 10, 2020
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

No branches or pull requests

3 participants