simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: mention that debug option is CLI only

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-12-11 13:25:36 -05:00
parent 2faff2637f
commit d51254f465
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/usage/configuration.md
View File

@ -143,6 +143,8 @@ CLI argument: `--debug`
Output debugging information. This can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`. Output debugging information. This can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
**Note**: The `debug` is used only supported via CLI argument. To enable debug mode from the [JS API](../developer-guide/js-api.md#javascript-api) use `require('debug').enable('semantic-release:*')`.
## Git environment variables ## Git environment variables
| Variable | Description | Default | | Variable | Description | Default |