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

Update per-crate licenses #683

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Update per-crate licenses #683

merged 1 commit into from
Dec 21, 2023

Conversation

alebastr
Copy link
Contributor

Several new crates were published without a mandatory MIT copyright notice, and that fails the checks in our downstream (Fedora) packaging tools.

See also #323

@kchibisov
Copy link
Member

I'd suggest to just adding symlinks, the way it's done with any other project having crates in workspaces.

@i509VCB
Copy link
Member

i509VCB commented Dec 18, 2023

I've seen this type of issue at least enough times to question whether there should be a clippy lint (workspace wide) to warn about this

- add license files to all new public crates
- use symlinks to ensure that the copyright notices are kept in sync
@alebastr
Copy link
Contributor Author

I'd suggest to just adding symlinks, the way it's done with any other project having crates in workspaces.

Fixed. I assumed there was a reason to copy the files initially. If there is none, symlinks indeed are better.

I've seen this type of issue at least enough times to question whether there should be a clippy lint (workspace wide) to warn about this

That would require being able to detect what files contain copyright notices. IIRC, the cargo team was against using license-files alongside the license metadata attribute and heuristics makes a bad lint.
Besides, not every license requires distributing the full text along with the source. Just the most commonly used ones :)

@NyxAlexandra
Copy link

IIRC there's a Cargo manifest option to specify the path to the license file. Would that be sufficient?

@elinorbgr
Copy link
Member

Thanks a lot!

@elinorbgr
Copy link
Member

IIRC at some point cargo publish had trouble with symlinks, I assume this is no longer an issue?

Copy link

codecov bot commented Dec 18, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7e98c79) 73.00% compared to head (a6a99e2) 72.39%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #683      +/-   ##
==========================================
- Coverage   73.00%   72.39%   -0.61%     
==========================================
  Files          48       48              
  Lines        7826     7826              
==========================================
- Hits         5713     5666      -47     
- Misses       2113     2160      +47     
Flag Coverage Δ
main 58.26% <ø> (ø)
test-- ?
test--server_system ?
test-client_system- 68.96% <ø> (ø)
test-client_system-server_system 51.42% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@kchibisov
Copy link
Member

IIRC at some point cargo publish had trouble with symlinks, I assume this is no longer an issue?

It's not an issue for a long time, I think, since that's how we're doing so in alacritty for a long time. But I do recall that it probably was at some point.

@elinorbgr elinorbgr merged commit 0200108 into Smithay:master Dec 21, 2023
14 of 15 checks passed
@alebastr alebastr deleted the add-missing-licenses branch December 23, 2023 20:14
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.

5 participants