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

Ensure license file is published with each crate #683

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

a-wai
Copy link
Contributor

@a-wai a-wai commented Jan 29, 2025

As the license file is present at the root of the repository, it isn't part of any crate on crates.io, as those lie in subfolders. Ensure this file is published by telling cargo where to find it.

@Stranger6667
Copy link
Owner

Thank you!

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.42%. Comparing base (33bce5a) to head (e5ef68c).
Report is 12 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #683   +/-   ##
=======================================
  Coverage   85.42%   85.42%           
=======================================
  Files          90       90           
  Lines       14137    14137           
=======================================
  Hits        12077    12077           
  Misses       2060     2060           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

codspeed-hq bot commented Jan 29, 2025

CodSpeed Performance Report

Merging #683 will not alter performance

Comparing a-wai:master (e5ef68c) with master (33bce5a)

Summary

✅ 45 untouched benchmarks

As the license file is present at the root of the repository, it isn't
part of any crate on crates.io, as those lie in subfolders. Ensure this
file is published by telling cargo where to find it.
@Stranger6667 Stranger6667 merged commit bc65e56 into Stranger6667:master Feb 5, 2025
37 of 38 checks passed
@Stranger6667
Copy link
Owner

Hm, now I see the following warnings

warning: <snip>/crates/testsuite-common/Cargo.toml: only one of `license` or `license-file` is necessary
`license` should be used if the package license can be expressed with a standard SPDX expression.
`license-file` should be used if the package uses a non-standard license.
See https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields for more information.

Checking the regex crate as a reference, it is indeed contains only license in every crate in its workspace.

Given this issue and this PR in regex, I'll follow their solution and will link the files around to keep them included in the uploaded artifacts + avoid the warnings.

@a-wai
Copy link
Contributor Author

a-wai commented Feb 7, 2025

Oh, I wasn't aware of that, my bad! FWIW I was inspired by this PR, but I'll keep this in mind for the future.

I guess a better fix would be for crates.io or cargo to add a LICENSE file when there is none but license is set and valid, I'll check if/what I can do there.

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.

None yet

2 participants