Exclude fuzzing/test data from the published crates.io package #1306
Conversation
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
During a dependency review I noticed that regex-automata includes binary fuzzing and test data. These files are not required for building regex-automata as dependency and make it a hard to review the code. This is similar to rust-lang#1281 This commit introduces a `include` directive in the `Cargo.toml` file to explicitly include only those files required to build `regex-automata`. This excludes the test directory and also reduces the size of the published crate from 122 files, 2.6MiB (610.6KiB compressed) to 77 files, 2.5MiB (584.0KiB compressed) which results in a 150 GB/month traffic reduction for crates.io assuming the current 6 million/month downloads and the difference in the compressed package size.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
During a dependency review I noticed that regex-automata includes binary fuzzing and test data. These files are not required for building regex-automata as dependency and make it a hard to review the code. This is similar to #1281
This commit introduces a
includedirective in theCargo.tomlfile to explicitly include only those files required to buildregex-automata. This excludes the test directory and also reduces the size of the published crate from 122 files, 2.6MiB (610.6KiB compressed) to 77 files, 2.5MiB (584.0KiB compressed) which results in a 150 GB/month traffic reduction for crates.io assuming the current 6 million/month downloads and the difference in the compressed package size.