Skip to content

Commit ece020b

Browse files
authored
docs: correct description of ACTIONS_STEP_DEBUG (#1041)
1 parent acf63b3 commit ece020b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1296,7 +1296,7 @@ See section [Yarn Modern](#yarn-modern) for information about using Yarn version
12961296

12971297
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:
12981298

1299-
```
1299+
```yml
13001300
DEBUG: @cypress/github-action
13011301
```
13021302

@@ -1311,9 +1311,11 @@ You can set the environment variable using GitHub UI interface, or in the workfl
13111311

13121312
See the [example-debug.yml](.github/workflows/example-debug.yml) workflow file.
13131313

1314+
To collect more verbose GitHub Action logs you can set a GitHub secret or variable `ACTIONS_STEP_DEBUG` to `true`. This is useful to see detailed caching steps. See [Enabling debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging) from GitHub Actions documentation for more information.
1315+
13141316
### Logs from the test runner
13151317

1316-
The above `ACTIONS_STEP_DEBUG` setting enables the debug logs from the action itself. To see the [Cypress debug logs](http://on.cypress.io/troubleshooting#Print-DEBUG-logs) add an environment variable to the action:
1318+
To see the [Cypress debug logs](http://on.cypress.io/troubleshooting#Print-DEBUG-logs) add an environment variable to the action:
13171319

13181320
```yml
13191321
- name: Cypress tests with debug logs

0 commit comments

Comments
 (0)