Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

doc: briefly explain what's included in npm publish #11188

Closed
wants to merge 1 commit into from

Conversation

beaugunderson
Copy link
Contributor

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 the npm publish documentation itself (my suggested description of the behavior may be too simplistic, but I wanted to have a starting point).

@othiym23
Copy link
Contributor

This is a great tweak, and I think a further sentence or two summarizing what happens when one or both of .gitignore or .npmignore drawn from npm-developers would be very useful to help prevent other people encountering this footgun. Thanks for putting this together, Beau!

@iarna iarna added this to the next milestone Jan 20, 2016
iarna pushed a commit that referenced this pull request Jan 20, 2016
@beaugunderson
Copy link
Contributor Author

@othiym23 no prob! (and sorry for making you respond on the weekend!)

I added a second sentence as requested. :)

iarna pushed a commit that referenced this pull request Jan 21, 2016
zkat pushed a commit that referenced this pull request Jan 21, 2016
@iarna
Copy link
Contributor

iarna commented Jan 25, 2016

This was merged to 3.5.5 & 2.14.16! =)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants