-
Notifications
You must be signed in to change notification settings - Fork 144
(bug) Fix spamming link test in deprecation warning (again) #1000
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
Conversation
We'd thought that the syntax in #974 would avoid auto-linking but didn't check closely enough, and now the deprecation issue it links to cannot be loaded due to having too many references. This updates the text to point to a new issue in a way that... I hope... will not be auto-linked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates a deprecation warning message to avoid auto-linking issues that were causing excessive references to a GitHub issue. The change modifies the text to reference a new issue number in a format that should prevent automatic linking.
- Updated deprecation warning text to reference issue 997 instead of the full GitHub issue path
- Simplified the reference format to avoid auto-linking behavior
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
claire153
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✨ Thank you for doing this!
Also nice that you got PR number 1000
| function addDenyListsDeprecationWarningToSummary(): void { | ||
| core.summary.addRaw( | ||
| `${icons.warning} <strong>Deprecation Warning</strong>: The <em>deny-licenses</em> option is deprecated for possible removal in the next major release. For more information, see actions/dependency-review-action/issues/938.`, | ||
| `${icons.warning} <strong>Deprecation Warning</strong>: The <em>deny-licenses</em> option is deprecated for possible removal in the next major release. For more information, see issue 997.`, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you would like to keep the longer version without linking to it, I think we can use back ticks like so:
| `${icons.warning} <strong>Deprecation Warning</strong>: The <em>deny-licenses</em> option is deprecated for possible removal in the next major release. For more information, see issue 997.`, | |
| `${icons.warning} <strong>Deprecation Warning</strong>: The <em>deny-licenses</em> option is deprecated for possible removal in the next major release. For more information, see \`actions/dependency-review-action/issues/997\`.`, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried and this does seem to work, but I'm still a bit scared that they will not be preserved, or the auto linking will happen regardless...
…1 [skip ci] Bumps [actions/dependency-review-action](https://github.com/actions/dependency-review-action) from 4.8.0 to 4.8.1. Release notes *Sourced from [actions/dependency-review-action's releases](https://github.com/actions/dependency-review-action/releases).* > Dependency Review Action v4.8.1 > ------------------------------- > > What's Changed > -------------- > > * (bug) Fix spamming link test in deprecation warning (again) by [`@ahpook`](https://github.com/ahpook) in [actions/dependency-review-action#1000](https://redirect.github.com/actions/dependency-review-action/pull/1000) > * Bump version for 4.8.1 release by [`@ahpook`](https://github.com/ahpook) in [actions/dependency-review-action#1001](https://redirect.github.com/actions/dependency-review-action/pull/1001) > > **Full Changelog**: <actions/dependency-review-action@v4...v4.8.1> Commits * [`40c09b7`](actions/dependency-review-action@40c09b7) Merge pull request [#1001](https://redirect.github.com/actions/dependency-review-action/issues/1001) from actions/ahpook/v4.8.1-release * [`4552948`](actions/dependency-review-action@4552948) Bump version for 4.8.1 release * [`e63da9a`](actions/dependency-review-action@e63da9a) Merge pull request [#1000](https://redirect.github.com/actions/dependency-review-action/issues/1000) from actions/ahpook/deprecation-redux * [`71365c7`](actions/dependency-review-action@71365c7) (bug) Fix spamming link test in deprecation warning (again) * See full diff in [compare view](actions/dependency-review-action@56339e5...40c09b7) [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
We'd thought that the syntax in #974 would avoid auto-linking
but didn't check closely enough, and now the deprecation issue
it links to cannot be loaded due to having too many references.
This updates the text to point to a new issue in a way that...
I hope... will not be auto-linked.
Related Issues
That's bait