Skip to content

Remove deprecated license_file from setup.cfg - #6375

Merged
blueyed merged 1 commit into
pytest-dev:masterfrom
hugovk:rm-deprecated-license_file-metadata
Jan 25, 2020
Merged

Remove deprecated license_file from setup.cfg#6375
blueyed merged 1 commit into
pytest-dev:masterfrom
hugovk:rm-deprecated-license_file-metadata

Conversation

@hugovk

@hugovk hugovk commented Dec 27, 2019

Copy link
Copy Markdown
Member
  • Target the master branch for bug fixes, documentation updates and trivial changes.
  • [trivial] Target the features branch for new features, improvements, and removals/deprecations.
  • [n/a] Include documentation when adding new features.
  • [n/a] Include new tests or update existing tests when applicable.

Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:

  • [trivial] Create a new changelog file in the changelog folder, with a name like <ISSUE NUMBER>.<TYPE>.rst. See changelog/README.rst for details.

  • Add yourself to AUTHORS in alphabetical order.


Replaces and closes #6348.

Starting with wheel 0.32.0 (2018-09-29), the license_file option is deprecated.

The wheel will continue to include LICENSE, it is now included automatically:

And LICENSE is still included in sdists thanks to setuptools-scm:

Comment thread setup.cfg
author = Holger Krekel, Bruno Oliveira, Ronny Pfannschmidt, Floris Bruynooghe, Brianna Laugher, Florian Bruhin and others

license = MIT license
license_file = LICENSE

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC LICENSE is added automatically when found in newer setuptools, correct?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'll be automatically included in sdists by setuptools-scm (#6348 (comment)), and by wheel in wheels (https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the confirmation! 👍

@blueyed

blueyed commented Jan 25, 2020

Copy link
Copy Markdown
Contributor

@hugovk
Please update the commit to include the description from the PR in the commit message.

Starting with wheel 0.32.0 (2018-09-29), the `license_file` option is deprecated.

* https://wheel.readthedocs.io/en/stable/news.html

The wheel will continue to include `LICENSE`, it is now included automatically:

* https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file

And `LICENSE` is still included in sdists thanks to setuptools-scm:

* #6348 (comment)
@hugovk

hugovk commented Jan 25, 2020

Copy link
Copy Markdown
Member Author

Done, how's this? fe343a7

@blueyed
blueyed merged commit b687f20 into pytest-dev:master Jan 25, 2020
@blueyed

blueyed commented Jan 25, 2020

Copy link
Copy Markdown
Contributor

Awesome, thanks!

@hugovk
hugovk deleted the rm-deprecated-license_file-metadata branch January 25, 2020 16:59
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

Successfully merging this pull request may close these issues.

3 participants