packaging: list files to be published to npm #889
Closed
Conversation
This file contains 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
mhdawson
approved these changes
Jan 26, 2021
TBH, I like the old way better. Npm packages shouldn't target minimum. |
|
We discussed in the NODE-API meeting and we agreed to give this a try and then see if we get complaints/concerns about the docs not being there. They will still be available through a clone of the github repo. |
mhdawson
pushed a commit
that referenced
this pull request
Feb 12, 2021
PR-URL: #889 Reviewed-By: Michael Dawson <midawson@redhat.com>
|
Landed as 458d895 |
17 tasks
kevindavies8
added a commit
to kevindavies8/node-addon-api-Develop
that referenced
this pull request
Aug 24, 2022
PR-URL: nodejs/node-addon-api#889 Reviewed-By: Michael Dawson <midawson@redhat.com>
Marlyfleitas
added a commit
to Marlyfleitas/node-api-addon-Development
that referenced
this pull request
Aug 26, 2022
PR-URL: nodejs/node-addon-api#889 Reviewed-By: Michael Dawson <midawson@redhat.com>
wroy7860
added a commit
to wroy7860/addon-api-benchmark-node
that referenced
this pull request
Sep 19, 2022
PR-URL: nodejs/node-addon-api#889 Reviewed-By: Michael Dawson <midawson@redhat.com>
johnfrench3
pushed a commit
to johnfrench3/node-addon-api-git
that referenced
this pull request
Aug 11, 2023
PR-URL: nodejs/node-addon-api#889 Reviewed-By: Michael Dawson <midawson@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hello, rather than exclude files to be published to
npmvia.npmignore, this PR switches to an inclusive approach viafiles.As it stands, this change will no longer include the markdown docs in the npm-published tarball as generally people view these on the web rather than via a npm download. I'd be happy to add the docs back to the tarball if required (it's a one line addition).
If we're willing to go without the docs, the resultant tarball is around half its previous size. Given this module is currently downloaded from npm almost 6 times every second (~3.5m/week), this improvement will reduce bandwidth and therefore energy consumption.
Currently published to npm:
What will be published with this change: