Skip to content

Commit

Permalink
docs: correct and extend ping debug instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 committed Oct 20, 2024
1 parent 40cfd36 commit 264fddc
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1478,16 +1478,26 @@ If you have a problem with `wait-on` not working, you can check the [src/ping.js
- start your server
- from another terminal call the `ping` yourself to validate the server is responding:

```
$ node src/ping-cli.js <url>
```shell
node src/ping-cli.js <url>
```

For example
For example:

```
```text
$ node src/ping-cli.js https://example.cypress.io
pinging url https://example.cypress.io for 30 seconds
::debug::pinging https://example.cypress.io has finished ok
```

You can also enable debug logs by setting the environment variable `DEBUG='@cypress/github-action'`, for example:

```text
$ DEBUG='@cypress/github-action' node src/ping-cli.js https://example.cypress.io
pinging url https://example.cypress.io for 30 seconds
@cypress/github-action total ping timeout 60000 +0ms
@cypress/github-action individual ping timeout 30000ms +0ms
@cypress/github-action retries limit 2 +0ms
@cypress/github-action pinging https://example.cypress.io has finished ok after 185ms +185ms
```

## More information
Expand Down

0 comments on commit 264fddc

Please sign in to comment.