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: disable markdown link check for SECURITY.md #445

Merged
merged 1 commit into from
May 10, 2022

Conversation

aramase
Copy link
Member

@aramase aramase commented May 10, 2022

Signed-off-by: Anish Ramasekar [email protected]

Reason for Change:

Check Markdown Links workflow has been failing for the past few days. The failure is mostly for the msrc and opensource.microsoft.com links.

[✖] https://www.microsoft.com/msrc → Status: 0 Error: ESOCKETTIMEDOUT
    at ClientRequest.<anonymous> (/usr/local/lib/node_modules/markdown-link-check/node_modules/request/request.js:816:19)
    at Object.onceWrapper (node:events:641:28)
    at ClientRequest.emit (node:events:527:28)
    at TLSSocket.emitRequestTimeout (node:_http_client:771:9)
    at Object.onceWrapper (node:events:641:28)
    at TLSSocket.emit (node:events:539:35)
    at TLSSocket.Socket._onTimeout (node:net:516:8)
    at listOnTimeout (node:internal/timers:559:17)
    at processTimers (node:internal/timers:[50](https://github.com/Azure/azure-workload-identity/runs/6361494612?check_suite_focus=true#step:4:50)2:7) {
  code: 'ESOCKETTIMEDOUT',
  connect: false
}

The failure with links is not consistent. In every run different links fail. This seems to indicate there is some requests blocked from CI processes to prevent DoS attacks. Disabling the link check only for SECURITY.md as those links will not change often.

Requirements

  • squashed commits
  • included documentation
  • added unit tests and e2e tests (if applicable).

Issue Fixed:

Please answer the following questions with yes/no:

Does this change contain code from or inspired by another project? If so, did you notify the maintainers and provide attribution?

  • yes
  • no

Notes for Reviewers:

@aramase aramase requested a review from chewong as a code owner May 10, 2022 14:12
@aramase aramase changed the title ci: disable markdown link check for SECUURITY.md ci: disable markdown link check for SECURITY.md May 10, 2022
@@ -1,5 +1,5 @@
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->

<!-- markdown-link-check-disable -->
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other option is to add folder-paths in the workflow and set specific paths to check for the markdown files. We'll need to keep updating that list if add markdown files in new folders. Instead adding this comment here to just disable the check in SECURITY.md.

@aramase aramase merged commit 55bd681 into Azure:main May 10, 2022
@aramase aramase deleted the fix-md-link-check branch May 10, 2022 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants