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

Exclude files from Cargo package #489

Merged
merged 2 commits into from Sep 29, 2022
Merged

Conversation

TehPers
Copy link
Contributor

@TehPers TehPers commented Sep 29, 2022

Closes #488

This excludes unnecessary files from the package that is published to crates.io. This reduces the size of the package to less than half of what it was before by excluding some of the larger files, especially the ones in the tests folder.

The files that are being included in the package as a result of this PR are:

  • src/*
  • LICENSE-MIT.md
  • README.md

Some other files I considered but did not include are:

  • examples/* (these can be found online, and rustdoc is still available offline)
  • Changelog.md (this file is rather large and may be better suited as an online resource)

To ensure that cargo publish is unaffected by the exclusion of unit tests and benchmarks, paths have been added explicitly to those items in the Cargo.toml file. See this thread for more information.

@codecov-commenter
Copy link

Codecov Report

Merging #489 (3ef8b10) into master (240f204) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #489      +/-   ##
==========================================
+ Coverage   54.02%   54.04%   +0.01%     
==========================================
  Files          30       30              
  Lines       12662    12649      -13     
==========================================
- Hits         6841     6836       -5     
+ Misses       5821     5813       -8     
Flag Coverage Δ
unittests 54.04% <ø> (+0.01%) ⬆️

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

Impacted Files Coverage Δ
src/lib.rs 12.66% <0.00%> (-0.29%) ⬇️
src/escapei.rs 12.10% <0.00%> (-0.06%) ⬇️
src/reader/parser.rs 98.61% <0.00%> (-0.01%) ⬇️
src/de/mod.rs 69.13% <0.00%> (+0.28%) ⬆️
src/reader/buffered_reader.rs 85.84% <0.00%> (+0.47%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@dralley dralley merged commit 9c32654 into tafia:master Sep 29, 2022
@TehPers TehPers deleted the exclude-files branch September 29, 2022 19:43
Mingun added a commit that referenced this pull request Oct 1, 2022
JOSEPHGILBY pushed a commit to JOSEPHGILBY/quick-xml that referenced this pull request Nov 5, 2022
JOSEPHGILBY pushed a commit to JOSEPHGILBY/quick-xml that referenced this pull request Nov 5, 2022
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.

Exclude extra files from package
4 participants