rust-lang/cargo

Published crates should include LICENSE file

raphlinus opened this issue · 5 comments

raphlinus commented

I'd like for published crates to include the text of the LICENSE along with the code. For our use case (making a repo of vendored crates), the cargo-vendor tool is populating the vendor directory with lots of packages that are missing LICENSE. There are basically two reasons for this:

  1. The LICENSE file is present in the source repository, in the same directory as the Cargo.toml config file, but the config file doesn't include the LICENSE in the list of files to be uploaded (because of an explicit "include" keyword). Examples include dtoa and serde.

  2. The LICENSE file is present in the source repo (typically in the repo root), but the crate is published from a subdirectory. Examples include num-traits and xi-core-lib.

There are (at least) two things "cargo publish" could do to mitigate this problem:

  1. The publish tool could do a lint check that an appropriate license file is present. There's a small amount of client-side sanity-checking now (checking that a license file exists if specified), and I believe the crates.io server also checks the spdx string.

  2. Automatically including LICENSE files from the repo root if publishing from a subdirectory.

I'll get around this for the time being by making my vendoring script do the latter at vendoring time, but I think it would be better if every stage in the chain precisely matched the exact contents.

joshtriplett commented

There's a third possibility that needs to be covered: the crate source cites a well-known license and intentionally does not include a license file. That's not necessarily a bug.

If the crate does include a license file, I'm entirely in favor of having cargo make sure it gets included.

Deleted user commented

And some licenses can be found in a COPYING file too. There are also PATENTS files that can change the meaning of a license to something else entirely. :(

stale commented

As there hasn't been any activity here in over 6 months I've marked this as stale and if no further activity happens for 7 days I will close it.

I'm a bot so this may be in error! If this issue should remain open, could someone (the author, a team member, or any interested party) please comment to that effect?

The team would be especially grateful if such a comment included details such as:

  • Is this still relevant?
  • If so, what is blocking it?
  • Is it known what could be done to help move this forward?

Thank you for contributing!

(The cargo team is currently evaluating the use of Stale bot, and using #6035 as the tracking issue to gather feedback.)

If you're reading this comment from the distant future, fear not if this was closed automatically. If you believe it's still an issue please leave a comment and a team member can reopen this issue. Opening a new issue is also acceptable!

joshtriplett commented

This issue still exists.

Would someone be interested in contributing to this? In particular, making cargo package check for a file named "LICENSE" or "COPYING" (or a few other patterns) and automatically including it in the .crate file?

  • 👍2
richardwhiuk commented

cargo publish does do this doesn't it - but cargo package doesn't?