Skip to content

Commit 8132565

Browse files
authored
docs: correct and extend ping debug instructions (#1284)
1 parent 40cfd36 commit 8132565

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1478,16 +1478,26 @@ If you have a problem with `wait-on` not working, you can check the [src/ping.js
14781478
- start your server
14791479
- from another terminal call the `ping` yourself to validate the server is responding:
14801480

1481-
```
1482-
$ node src/ping-cli.js <url>
1481+
```shell
1482+
node src/ping-cli.js <url>
14831483
```
14841484

1485-
For example
1485+
For example:
14861486

1487-
```
1487+
```text
14881488
$ node src/ping-cli.js https://example.cypress.io
14891489
pinging url https://example.cypress.io for 30 seconds
1490-
::debug::pinging https://example.cypress.io has finished ok
1490+
```
1491+
1492+
You can also enable debug logs by setting the environment variable `DEBUG='@cypress/github-action'`, for example:
1493+
1494+
```text
1495+
$ DEBUG='@cypress/github-action' node src/ping-cli.js https://example.cypress.io
1496+
pinging url https://example.cypress.io for 30 seconds
1497+
@cypress/github-action total ping timeout 60000 +0ms
1498+
@cypress/github-action individual ping timeout 30000ms +0ms
1499+
@cypress/github-action retries limit 2 +0ms
1500+
@cypress/github-action pinging https://example.cypress.io has finished ok after 185ms +185ms
14911501
```
14921502

14931503
## More information

0 commit comments

Comments
 (0)