Skip to content

Commit

Permalink
Switch from license-file to license
Browse files Browse the repository at this point in the history
According to the cargo docs[1], the license field is used when you have
a standard license that has an existing SPDX 2.3 license expression.
The license-file field should be used when you are using a non-standard
license type that needs more details.

So why does this matter?  Some automated tools will parse these fields
and use them as an input to license compliance checks.  When using the
license-file field it will go a more complicated path, where an MIT
license should just get a rubber stamp from compliance.

This change has no impact on the actual licensing, it just reflects it
better in a machine parsable way
  • Loading branch information
stusmall committed Dec 13, 2024
1 parent 33a3428 commit 462a66c
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 22 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition = "2021"
description = "This crate provides access to a set of strongly typed apis to interact with consul (https://www.consul.io/)"
readme = "README.md"
repository = "https://github.com/Roblox/rs-consul"
license-file = "LICENSE"
license = "MIT"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[features]
Expand Down
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

0 comments on commit 462a66c

Please sign in to comment.