Closed jusiskin closed 6 months ago
We encountered a failure trying to publish to PyPI:
ERROR `long_description` has syntax errors in markup and would not be rendered on PyPI.
The package was also missing a license in pyproject.toml.
pyproject.toml
Discovered in pypa/gh-action-pypi-publish#162, the fix was to add the following to pyproject.toml:
[project] readme = "README.md"
Added our license to pyproject.toml
We will be able to publish to PyPI without the above failure.
Ran hatch build and inspected the built archives. Confirmed the README.md was included.
hatch build
README.md
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
What was the problem/requirement? (What/Why)
1. Publishing Error
We encountered a failure trying to publish to PyPI:
2. Missing license
The package was also missing a license in
pyproject.toml
.What was the solution? (How)
Discovered in pypa/gh-action-pypi-publish#162, the fix was to add the following to
pyproject.toml
:Added our license to
pyproject.toml
What is the impact of this change?
We will be able to publish to PyPI without the above failure.
How was this change tested?
Ran
hatch build
and inspected the built archives. Confirmed theREADME.md
was included.Was this change documented?
No
Is this a breaking change?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.