Add SPDX license field (MIT) to Cargo.toml#125
Merged
Conversation
MarijnS95
changed the title
license field (MIT)license field (MIT) to Cargo.toml
Owner
|
Thanks! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Cargo.tomldeclares the license vialicense-fileonly. This adds the SPDXlicense = "MIT"field so tooling that reads the SPDX expression — crates.io metadata, license scanners,cargo-deny— picks it up directly.Both fields are valid together and complementary:
licensegives the SPDX identifier, andlicense-filekeeps the full MIT text with its required copyright line (Copyright (c) 2024 Maksym Pavlenko). No change to theLICENSEfile.crates.io even renders your license as
non-standardbecause of this, andcargo-denyemits ano-license-fieldwarning foropenusd— which-D warningspromotes to a hard error. A[[licenses.clarify]]entry resolves the license expression (to MIT, from theLICENSEtext) but does not opt out of that lint, so downstream consumers currently have to pass--allow no-license-fieldon the CLI. Adding the SPDX field removes the need for that workaround.