Skip to content
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

Document automatic addition of LICENSE files in built packages #8553

Closed
1 task done
asikeero opened this issue Oct 18, 2023 · 2 comments · Fixed by #8555
Closed
1 task done

Document automatic addition of LICENSE files in built packages #8553

asikeero opened this issue Oct 18, 2023 · 2 comments · Fixed by #8555
Labels
area/docs Documentation issues/improvements

Comments

@asikeero
Copy link
Contributor

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

When building a project with poetry build, if one has a LICENSE file defined in the root of the project, this file will be included in the package.

I could not find this behaviour documented anywhere. I believe it would be worth mentioning that:

  1. This behaviour exists
  2. It only works for a file named as LICENSE* in the root folder

To me, the place in the docs I would expect this information to be is either in describing the fields license or include in the pyproject.toml or in the section talking about packaging.

@asikeero asikeero added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Oct 18, 2023
@dimbleby
Copy link
Contributor

Be the change you want to see - submit a merge request!

Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 29, 2024
@abn abn removed the status/triage This issue needs to be triaged label Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants