Skip to content

Commit 6b3bc3a

Browse files
bahmutovbahmutov
authored
feat: switch to debug module for verbose logs (#379)
This action uses the [debug](https://github.com/visionmedia/debug#readme) module to output additional verbose logs. You can see these debug messages by setting the following environment variable: ``` DEBUG: @cypress/github-action ``` You can set the environment variable using GitHub UI interface, or in the workflow file: ```yml - name: Cypress tests with debug logs uses: cypress-io/github-action@v2 env: DEBUG: '@cypress/github-action' ```
1 parent 6932ccd commit 6b3bc3a

7 files changed

Lines changed: 1887 additions & 692 deletions

File tree

‎.github/workflows/example-debug.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: example-debug
2+
on: push
3+
jobs:
4+
nightly:
5+
runs-on: ubuntu-20.04
6+
steps:
7+
- name: Checkout
8+
uses: actions/checkout@v2
9+
10+
- name: Cypress debug logs 📝
11+
uses: ./
12+
env:
13+
DEBUG: '@cypress/github-action'
14+
with:
15+
working-directory: examples/basic

‎README.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,14 +1063,22 @@ This action uses several production dependencies. The minimum Node version requi
10631063

10641064
## Debugging
10651065

1066-
You can see verbose messages from GitHub Actions by setting the following secrets (from [Debugging Actions Guide](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs))
1066+
This action uses the [debug](https://github.com/visionmedia/debug#readme) module to output additional verbose logs. You can see these debug messages by setting the following environment variable:
10671067

10681068
```
1069-
ACTIONS_RUNNER_DEBUG: true
1070-
ACTIONS_STEP_DEBUG: true
1069+
DEBUG: @cypress/github-action
10711070
```
10721071
1073-
The `ACTIONS_RUNNER_DEBUG` will show generic Actions messages, while `ACTIONS_STEP_DEBUG` will enable the `core.debug(...)` messages from this actions.
1072+
You can set the environment variable using GitHub UI interface, or in the workflow file:
1073+
1074+
```yml
1075+
- name: Cypress tests with debug logs
1076+
uses: cypress-io/github-action@v2
1077+
env:
1078+
DEBUG: '@cypress/github-action'
1079+
```
1080+
1081+
See the [example-debug.yml](./.github/workflows/example-debug.yml) workflow file.
10741082

10751083
### Logs from the test runner
10761084

0 commit comments

Comments
 (0)