Skip to content

docs: quote npm package name in changelog#1523

Merged
jennifer-shehane merged 1 commit into
cypress-io:masterfrom
MikeMcC399:fix/changelog-link
Aug 21, 2025
Merged

docs: quote npm package name in changelog#1523
jennifer-shehane merged 1 commit into
cypress-io:masterfrom
MikeMcC399:fix/changelog-link

Conversation

@MikeMcC399
Copy link
Copy Markdown
Collaborator

Situation

The workflow workflows/check-markdown.yml reports a false positive bad link:

FILE: CHANGELOG.md
  [✓] https://github.com/cypress-io/github-action
  [✓] https://github.com/cypress-io/github-action/releases
  [✖] mailto:cache@4.0.0
  [✓] https://github.com/cypress-io/github-action/tree/v5
  [✓] https://on.cypress.io/module-api

  ERROR: 1 dead links found!

  5 links checked.
  [✖] mailto:cache@4.0.0 → Status: 400

Change

In the CHANGELOG.md add code backticks to @actions/cache@4.0.0 to avoid the npm package name being interpreted as an e-mail address by markdown-link-check.

Verify

npm run check:markdown-links

and confirm that no dead links are reported.

@cypress-app-bot
Copy link
Copy Markdown
Collaborator

@MikeMcC399 MikeMcC399 added bug Something isn't working documentation Improvements or additions to documentation labels Aug 21, 2025
@MikeMcC399 MikeMcC399 self-assigned this Aug 21, 2025
@MikeMcC399 MikeMcC399 marked this pull request as ready for review August 21, 2025 11:20
@MikeMcC399
Copy link
Copy Markdown
Collaborator Author

There's a known bug in markdown-link-check@3.13.7 where it always returns success (0) even if it finds dead links, explaining why this issue went unnoticed for months. It was a false positive, so actually there was no dead link, but even so it would have been nice to have been informed through the workflow failing. I'll monitor markdown-link-check for a fix.

@jennifer-shehane jennifer-shehane merged commit 17ae54c into cypress-io:master Aug 21, 2025
80 checks passed
@MikeMcC399 MikeMcC399 deleted the fix/changelog-link branch August 21, 2025 14:35
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 6.10.3 🎉

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.

4 participants