aws-deadline / deadline-cloud-test-fixtures

This package contains pytest fixtures that are used to test AWS Deadline Cloud Python packages
Apache License 2.0
9 stars 13 forks source link

chore: add readme and license to published artifacts #91

Closed jusiskin closed 6 months ago

jusiskin commented 6 months ago

What was the problem/requirement? (What/Why)

1. Publishing Error

We encountered a failure trying to publish to PyPI:

ERROR    `long_description` has syntax errors in markup and would not be        
         rendered on PyPI.

2. Missing license

The package was also missing a license in pyproject.toml.

What was the solution? (How)

  1. Discovered in pypa/gh-action-pypi-publish#162, the fix was to add the following to pyproject.toml:

    [project]
    readme = "README.md"
  2. 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 the README.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.