feat: add a verbose flag
#3934
feat: add a verbose flag
#3934
Conversation
ehmicky
added
the
type: chore
github-actions
bot
added
the
type: feature
| } | ||
|
|
||
| const logPluginMethodStart = function (verbose) { | ||
| logVerbose(undefined, verbose, 'Plugin logic started.') |
There was a problem hiding this comment.
logs is undefined when inside the plugin's child process, which is normal.
| 1. ./plugin (onPreBuild event) ␊ | ||
| ────────────────────────────────────────────────────────────────␊ | ||
| ␊ | ||
| Step starting.␊ |
There was a problem hiding this comment.
Main process is about to send message to plugin process.
| ────────────────────────────────────────────────────────────────␊ | ||
| ␊ | ||
| Step starting.␊ | ||
| Step started.␊ |
There was a problem hiding this comment.
Main process successfully sent message to plugin process.
| ␊ | ||
| Step starting.␊ | ||
| Step started.␊ | ||
| Plugin logic started.␊ |
There was a problem hiding this comment.
Plugin process is about to execute plugin event handler.
| Step started.␊ | ||
| Plugin logic started.␊ | ||
| test␊ | ||
| Plugin logic ended.␊ |
There was a problem hiding this comment.
Plugin event handler completed.
| Plugin logic started.␊ | ||
| test␊ | ||
| Plugin logic ended.␊ | ||
| Stop closing.␊ |
There was a problem hiding this comment.
Plugin process is about to send its response message to the main process.
| Plugin logic ended.␊ | ||
| Stop closing.␊ | ||
| Step closed.␊ | ||
| Step ended.␊ |
There was a problem hiding this comment.
Main process received the plugin process's response message for this step.
| Stop closing.␊ | ||
| Step closed.␊ | ||
| Step ended.␊ | ||
| Step completed.␊ |
There was a problem hiding this comment.
Main process disconnected stdout/stderr from the plugin's process.
ehmicky
removed
the
type: feature
ehmicky
force-pushed
the
feat/verbose
branch
from
f6f1c0c to
e877683
Compare
JGAntunes
left a comment
JGAntunes
left a comment
There was a problem hiding this comment.
Left a comment which we can revisit later, but LGTM 👍
| debug: { | ||
| boolean: true, | ||
| describe: 'Print debugging information', | ||
| describe: 'Print user-facing debugging information', | ||
| hidden: true, | ||
| }, | ||
| verbose: { | ||
| boolean: true, | ||
| describe: 'Print internal debugging information', | ||
| hidden: true, | ||
| }, |
There was a problem hiding this comment.
Given the need for this ASAP I'm ok with the flag, but what do you think of having debug levels in the future? It would be more suited IMO vs these flags which can be confusing
There was a problem hiding this comment.
Yes, I was thinking this should be the next step as well!
Note than from a user standpoint, they use the NETLIFY_BUILD_DEBUG environment variable for both debug and verbose, so there's currently a single level from their perspective. The buildbot and CLI do not pass the verbose flag, so the only difference is for the tests, which sets verbose as false and debug as true.
github-actions
bot
added
the
type: feature
Fixes #3933
This adds a
verboseCLI flag. The default value isfalse.It can be enabled with the environment variable
NETLIFY_BUILD_DEBUG=true(just like thedebugCLI flag). The reason this is using a separate CLI flag is because theverboseisfalsein tests whiledebugistrue, since verbose logs make test snapshots harder to read.The
verboseCLI flag has the same purpose as thedebugflag, but for more verbose log messages.At the moment, it prints messages indicating the different steps of plugins orchestration and IPC. This allows us to debug issues related to plugins hanging.
For us to review and ship your PR efficiently, please perform the following steps:
passes our tests.