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

Fix missing license file in published crate #88

Merged
merged 1 commit into from
Apr 30, 2024

Conversation

musicinmybrain
Copy link
Contributor

Add a symbolic link to the top-level LICENSE file so that the license text is distributed with the crate as required by the terms of the chosen MIT license.

Before this PR:

$ gh repo clone pydantic/jiter
$ cd jiter/crates/jiter
$ cargo publish --dry-run
$ tar -tzvf ../../target/package/jiter-0.3.0.crate
-rw-r--r-- 0/0             106 1969-12-31 19:00 jiter-0.3.0/.cargo_vcs_info.json
-rw-r--r-- 0/0            2101 1969-12-31 19:00 jiter-0.3.0/Cargo.toml
-rw-r--r-- 0/0            1335 2006-07-23 21:21 jiter-0.3.0/Cargo.toml.orig
-rw-r--r-- 0/0            6842 2006-07-23 21:21 jiter-0.3.0/README.md
-rw-r--r-- 0/0           17519 2006-07-23 21:21 jiter-0.3.0/benches/bigints_array.json
[…]
-rw-r--r-- 0/0             103 2006-07-23 21:21 jiter-0.3.0/benches/x100.json
-rw-r--r-- 0/0              85 2006-07-23 21:21 jiter-0.3.0/build.rs
-rw-r--r-- 0/0            9213 2006-07-23 21:21 jiter-0.3.0/src/errors.rs
[…]
-rw-r--r-- 0/0           10247 2006-07-23 21:21 jiter-0.3.0/src/value.rs
-rw-r--r-- 0/0           55342 2006-07-23 21:21 jiter-0.3.0/tests/main.rs
-rw-r--r-- 0/0            9952 2006-07-23 21:21 jiter-0.3.0/tests/python.rs

After this PR:

$ cargo publish --dry-run
$ tar -tzvf ../../target/package/jiter-0.3.0.crate
-rw-r--r-- 0/0             106 1969-12-31 19:00 jiter-0.3.0/.cargo_vcs_info.json
-rw-r--r-- 0/0            2101 1969-12-31 19:00 jiter-0.3.0/Cargo.toml
-rw-r--r-- 0/0            1335 2006-07-23 21:21 jiter-0.3.0/Cargo.toml.orig
-rw-r--r-- 0/0            1091 2006-07-23 21:21 jiter-0.3.0/LICENSE
-rw-r--r-- 0/0            6842 2006-07-23 21:21 jiter-0.3.0/README.md
-rw-r--r-- 0/0           17519 2006-07-23 21:21 jiter-0.3.0/benches/bigints_array.json
[…]

Note that the symbolic link is dereferenced and the license text is included in the crate as a regular file.

Add a symbolic link to the top-level LICENSE file.
@musicinmybrain
Copy link
Contributor Author

This could be done for the fuzz and jiter-python crates, too, but it’s less important since they’re not on crates.io and are much less likely to be separated from the git repository and distributed as crate files.

Copy link

codspeed-hq bot commented Apr 30, 2024

CodSpeed Performance Report

Merging #88 will not alter performance

Comparing musicinmybrain:license-file (25e6979) with main (919a9b6)

Summary

✅ 73 untouched benchmarks

Copy link
Collaborator

@davidhewitt davidhewitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@davidhewitt davidhewitt merged commit 75699eb into pydantic:main Apr 30, 2024
12 checks passed
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.

2 participants