Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct and extend ping debug instructions #1284

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

MikeMcC399
Copy link
Collaborator

Issue

The README > Debugging waiting for URL to respond contains an example:

$ 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

where the last line of the example is incorrect.

Without debugging enabled, the output under Node.js v20.18.0 LTS appears as:

$ node src/ping-cli.js https://example.cypress.io
pinging url https://example.cypress.io for 30 seconds

With debugging enabled, the output is as follows:

$ 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

Change

Provide correct instructions in README > Debugging waiting for URL to respond for running node src/ping-cli.js in debug and non-debug mode.

@MikeMcC399 MikeMcC399 added bug Something isn't working documentation Improvements or additions to documentation labels Oct 20, 2024
@MikeMcC399 MikeMcC399 self-assigned this Oct 20, 2024
@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 marked this pull request as ready for review October 20, 2024 11:02
@jennifer-shehane jennifer-shehane merged commit 8132565 into cypress-io:master Oct 21, 2024
76 checks passed
@MikeMcC399 MikeMcC399 deleted the fix/ping-debug-doc branch October 21, 2024 16:36
Copy link

github-actions bot commented Nov 4, 2024

🎉 This PR is included in version 6.7.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants