Skip to content

Commit

Permalink
doc, bin: stop suggesting opening node-gyp issues
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
bzoz committed Apr 16, 2020
1 parent e15fad7 commit 5d06460
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 8 deletions.
32 changes: 27 additions & 5 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
<!--
Thank you for reporting an issue. The more information you can give us, the
better the chance we can fix your problem.
Thank you for reporting an issue!
Remember, this issue tracker is for reporting issues ONLY with node-gyp.
If you have an issue installing a specific module, please file an issue on
that module's issue tracker (`npm issues modulename`). Open issue here only if
you are sure this is an issue with node-gyp, not with the module you are
trying to build.
Fill out the form below. We probably won't investigate an issue that does not
provide the basic information we require.
This issue tracker is for issues with node-gyp,
if you have an issue installing a specific module, please file an issue on
that module's issue tracker (`npm issues modulename`).
-->

* **Node Version**: <!-- `node -v` and `npm -v` -->
Expand All @@ -19,6 +25,22 @@ Paste your log here, between the backticks. It can be:
- npm --verbose output,
- or contents of npm-debug.log,
- or output of node-gyp rebuild --verbose.
Include the command you were trying to run.
This should look like this:
>npm --verbose
npm info it worked if it ends with ok
npm verb cli [
npm verb cli 'C:\\...\\node\\13.9.0\\x64\\node.exe',
npm verb cli 'C:\\...\\node\\13.9.0\\x64\\node_modules\\npm\\bin\\npm-cli.js',
npm verb cli '--verbose'
npm verb cli ]
npm info using npm@6.13.7
npm info using node@v13.9.0
Usage: npm <command>
(...)
```

</details>
Expand Down
5 changes: 2 additions & 3 deletions bin/node-gyp.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,8 @@ function errorMessage () {

function issueMessage () {
errorMessage()
log.error('', ['This is a bug in `node-gyp`.',
'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 npm and/or node-gyp and if it does not help file an issue with the package author.'
].join('\n'))
}

Expand Down

1 comment on commit 5d06460

@kenning
Copy link

Choose a reason for hiding this comment

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

🤔🤔🤔

Please sign in to comment.