This repository was archived by the owner on Aug 11, 2022. It is now read-only.
doc: briefly explain what's included in npm publish
#11188
Closed
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.
In this Twitter thread I walk through how after publishing versions from many modules (38) I managed to not know that
npm publish
includes all files that are not explicitly ignored by a local.gitignore
or.npmignore
(or disallowed by.gitignore
but allowed by.npmignore
), and found that I'd managed to include security credentials (since revoked) in published versions of one of my modules, and junk files in many others. I think it would be great to briefly note what's included in thenpm publish
documentation itself (my suggested description of the behavior may be too simplistic, but I wanted to have a starting point).