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

include LICENSE file with peg-macros and peg-runtime crates #241

Closed
wants to merge 1 commit into from
Closed

Conversation

decathorpe
Copy link

Right now, the peg-macros and peg-runtime crates available from crates.io don't include the LICENSE text. However, the MIT license requires that the license text is distributed with the sources that are covered by the license, see "Conditions" here:
https://choosealicense.com/licenses/mit/

Including the "LICENSE" file with include = ["../LICENSE"] in the [package] sections of both peg-macros and peg-runtime should do the trick. See: https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields

I was, however, unable to test this, since I couldn't figure out how to make cargo aware of the workspace layout in this repo :(

@kevinmehall
Copy link
Owner

Thanks for pointing this out.

The include doesn't seem to have the intended effect -- it's not including the LICENSE file, and it's also making the package not include any of the source files:

$ cargo package -l
.cargo_vcs_info.json
Cargo.lock
Cargo.toml
Cargo.toml.orig

From the docs you linked:

Note that include must be an exhaustive list of files as otherwise necessary source files may not be included.

Instead, I've just symlinked LICENSE into each of the directories in 3d4cd82

@decathorpe
Copy link
Author

Oh. Yeah, that explains why cargo fell down after I added this ... 🤦‍♂️
Thanks for fixing it 👍

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