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: publish of tarballs includes README in packument #4480

Merged
merged 1 commit into from
Mar 2, 2022

Conversation

fritzy
Copy link
Contributor

@fritzy fritzy commented Feb 28, 2022

When pacote is used for prepping a tarball for publish (non directory publishes), invoke with fullReadJSON: true so that the README is included in the tarball.

Closes #3548

@fritzy fritzy requested a review from a team as a code owner February 28, 2022 05:36
@npm-robot
Copy link
Contributor

found 20 benchmarks with statistically significant performance improvements

  • app-large: clean, lock-only, cache-only, cache-only:peer-deps, modules-only, no-lock, no-cache, no-modules, no-clean, no-clean:audit
  • app-medium: clean, lock-only, cache-only, cache-only:peer-deps, modules-only, no-lock, no-cache, no-modules, no-clean, no-clean:audit
timing results
app-large clean lock-only cache-only cache-only
peer-deps
modules-only no-lock no-cache no-modules no-clean no-clean
audit
npm@8 59.638 ±0.66 27.812 ±0.19 25.759 ±13.19 18.018 ±0.29 2.814 ±0.01 2.694 ±0.06 2.096 ±0.06 10.511 ±0.12 2.105 ±0.07 2.935 ±0.05
#4480 0.414 ±0.01 0.367 ±0.01 0.362 ±0.01 0.397 ±0.00 0.401 ±0.01 0.362 ±0.00 0.405 ±0.01 0.374 ±0.00 0.406 ±0.00 0.394 ±0.01
app-medium clean lock-only cache-only cache-only
peer-deps
modules-only no-lock no-cache no-modules no-clean no-clean
audit
npm@8 37.615 ±1.78 21.379 ±0.02 11.768 ±0.14 12.366 ±0.46 2.496 ±0.04 2.457 ±0.06 1.993 ±0.02 7.923 ±0.00 2.103 ±0.00 2.610 ±0.08
#4480 0.364 ±0.00 0.392 ±0.04 0.381 ±0.00 0.401 ±0.00 0.386 ±0.03 0.402 ±0.01 0.362 ±0.00 0.392 ±0.04 0.370 ±0.00 0.380 ±0.01

Copy link
Member

@wraithgar wraithgar left a comment

Choose a reason for hiding this comment

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

yay

@wraithgar wraithgar changed the base branch from latest to release-next March 1, 2022 15:47
@wraithgar wraithgar merged commit defe79a into release-next Mar 2, 2022
@wraithgar wraithgar deleted the fritzy/tarball-readme branch March 2, 2022 15:39
This was referenced Mar 3, 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.

[BUG] publishing a tarball does not include readme
3 participants