chore: add readme and license to published artifacts #91
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
epmog
previously approved these changes
Apr 1, 2024
marofke
previously approved these changes
Apr 1, 2024
Signed-off-by: Josh Usiskin <[email protected]>
jusiskin
force-pushed
the
jusiskin/publish_readme_in_build_artifacts
branch
from
f6dfde4 to
054fdb7
Compare
jusiskin
changed the title
moorec-aws
approved these changes
Apr 1, 2024
marofke
approved these changes
Apr 1, 2024
epmog
approved these changes
Apr 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 Error:
long_descriptionhas syntax errors in markup and would not be rendered on PyPI pypa/gh-action-pypi-publish#162, the fix was to add the following topyproject.toml:Added our license to
pyproject.tomlWhat 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 buildand inspected the built archives. Confirmed theREADME.mdwas 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.