From d51254f465b069b6919c1db9abba858d5cd2d5cc Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Tue, 11 Dec 2018 13:25:36 -0500 Subject: [PATCH] docs: mention that `debug` option is CLI only --- docs/usage/configuration.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 4004f32c..0c67e698 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -143,6 +143,8 @@ CLI argument: `--debug` 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 | Variable | Description | Default |