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

ci: remove microsoft windows from markdown-link-check #1057

Merged
merged 1 commit into from Oct 23, 2023

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Oct 17, 2023

Issue

Since last week npm run check:markdown has been sporadically failing when checking the link

[Microsoft Windows](https://www.microsoft.com/windows/) to https://www.microsoft.com/windows/ in the document

docs/MAINTENANCE.md.

This is the portion of the check log showing the failure:

FILE: docs/MAINTENANCE.md
  [✓] ../examples
  [✓] https://docs.cypress.io/guides/references/configuration
  [✓] https://github.com/cypress-io/github-action
  [✓] https://www.npmjs.com/
  [✓] https://pnpm.io/
  [✓] https://classic.yarnpkg.com/
  [✓] https://yarnpkg.com/
  [✓] https://github.com/cypress-io/github-action/tree/v5/examples/v9
  [✓] https://github.com/cypress-io/github-action/tree/v5/
  [✓] https://docs.cypress.io/guides/references/legacy-configuration
  [✓] https://ubuntu.com/
  [✖] https://www.microsoft.com/windows/
  [✓] https://www.apple.com/macos/
  [✓] https://nodejs.org/en/
  [✓] ../CONTRIBUTING.md#requirements
  [✓] https://git-scm.com/
  [✓] https://nodejs.org/
  [✓] https://code.visualstudio.com/
  [✓] https://docs.cypress.io/guides/references/changelog
  [✓] ../.github/workflows/example-install-only.yml

  20 links checked.

  ERROR: 1 dead links found!
  [✖] https://www.microsoft.com/windows/ → Status: 0

When accessed manually in a browser (instead of automatically through the npm module markdown-link-check) the browser correctly displays a localized version of the page.

If the link is checked by Cypress with a cy.visit(https://www.microsoft.com/windows/) the page is displayed, however there is a marked delay of several seconds.

In similar situations where the issue has been sporadic and the failing only occurs when checking the link with markdown-link-check, the reason behind the failure has been increased network security, for instance as protection against Denial of Service attacks.

Change

Using Disable comments
<!-- markdown-link-check-disable --> and
<!-- markdown-link-check-enable -->
the link https://www.microsoft.com/windows/ in docs/MAINTENANCE.md is disabled from markdown-link-check-ing.

Verification

Execute the following locally

npx markdown-link-check -c md-linkcheck.json docs/MAINTENANCE.md

and confirm 19 links checked. successfully.

Execute

npm run check:markdown

and confirm that all links in all checked files are successfully checked.

@cypress-app-bot
Copy link

@MikeMcC399
Copy link
Collaborator Author

@jennifer-shehane
This PR is required to prevent regular sporadic failures in the CI checks for this repo.

Microsoft seems to have implemented additional security which prevents reliable automated checking of the link to https://www.microsoft.com/windows/.

@mschile mschile merged commit 2eae5a3 into cypress-io:master Oct 23, 2023
71 checks passed
@MikeMcC399 MikeMcC399 deleted the markdown-link-check-windows branch October 24, 2023 05:13
Copy link

🎉 This PR is included in version 6.6.0 🎉

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants