Exclude the book from published crates#1089
Merged
Merged
Conversation
✅ Deploy Preview for salsa-rs canceled.
|
1 similar comment
✅ Deploy Preview for salsa-rs canceled.
|
Contributor
|
Thank you |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This has a couple of advantages.
Most obviously, this greatly reduces the sizes of the published crates, and doing so comes at no cost since nothing else in the crate references the contents of
book/. Before this PR:After this PR:
Less obviously, the presence of
book/mermaid.cssandbook/mermaid.min.jscomplicates the source license situation of the published crates. These files aren’t compiled into libraries or executables, but merely having them in the source means that people like me (working on arust-salsapackage for Fedora) do have to worry about whether their licenses are properly documented, properly attributed, and allowable, including bothmermaiditself and any NPM dependencies bundled intomermaid.min.js. Excluding these unnecessary sources from the crate makes all of these annoyances disappear.