doc, bin: stop suggesting opening node-gyp issues #2096
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
A lot of new issues in node-gyp are related to outdated node-gyp or broken modules. This removes the suggestion to open a new issue in the node-gyp, instead suggesting the user should open the issue in the module issue tracker. It also makes the issue template more explicit about providing the logs.
cclauss
reviewed
Apr 7, 2020
| npm info using node@v13.9.0 | ||
|
|
||
| Usage: npm <command> | ||
| (...) |
There was a problem hiding this comment.
Should we talk about three backticks on a line by themselves above the first line of the log and the same below the last line of the log?
There was a problem hiding this comment.
I hope that people will just overwrite the example output, not paying to much attention to the backticks. We can add one more extra line here to make it easier for users to use backticks correctly.
cclauss
approved these changes
Apr 7, 2020
rvagg
reviewed
Apr 8, 2020
bin/node-gyp.js
Outdated
| 'Try to update node-gyp and file an Issue if it does not help:', | ||
| ' <https://github.com/nodejs/node-gyp/issues>' | ||
| log.error('', ['Node-gyp failed to build your package.', | ||
| 'Try to update node-gyp and if it does not help file an issue with the package author' |
There was a problem hiding this comment.
"update node-gyp" is no trivial matter though, I think this was written even before it was bundled with npm. Maybe we should say "Try to update npm and/or node-gyp" or something along those lines? I don't think we can fit in explanations of how to make npm use an external node-gyp in this message and that's not necessarily good practice anyway.
|
Updated. PTAL |
rvagg
approved these changes
Apr 8, 2020
bzoz
added a commit
that referenced
this pull request
Apr 16, 2020
A lot of new issues in node-gyp are related to outdated node-gyp or broken modules. This removes the suggestion to open a new issue in the node-gyp, instead suggesting the user should open the issue in the module issue tracker. It also makes the issue template more explicit about providing the logs. PR-URL: #2096 Reviewed-By: Christian Clauss <cclauss@me.com> Reviewed-By: Rod Vagg <rod@vagg.org>
|
Landed in 5d06460 |
rvagg
pushed a commit
that referenced
this pull request
May 13, 2020
A lot of new issues in node-gyp are related to outdated node-gyp or broken modules. This removes the suggestion to open a new issue in the node-gyp, instead suggesting the user should open the issue in the module issue tracker. It also makes the issue template more explicit about providing the logs. PR-URL: #2096 Reviewed-By: Christian Clauss <cclauss@me.com> Reviewed-By: Rod Vagg <rod@vagg.org>
rvagg
pushed a commit
that referenced
this pull request
May 13, 2020
A lot of new issues in node-gyp are related to outdated node-gyp or broken modules. This removes the suggestion to open a new issue in the node-gyp, instead suggesting the user should open the issue in the module issue tracker. It also makes the issue template more explicit about providing the logs. PR-URL: #2096 Reviewed-By: Christian Clauss <cclauss@me.com> Reviewed-By: Rod Vagg <rod@vagg.org>
Closed
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.
Checklist
npm install && npm testpassesDescription of change
A lot of new issues in node-gyp are related to outdated node-gyp or broken modules. This removes the suggestion to open a new issue in the node-gyp, instead suggesting the user should open the issue in the module issue tracker.
It also makes the issue template more explicit about providing the logs.