chore: simplify deprecation notice check #4577
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
testing
http
fmt
streams
crypto
encoding
flags
io
path
semver
yaml
permissions
labels
|
I find the existing check of removal version numbers is useful. I don't see the reason to remove it. |
|
It did. But not all deprecation notices contain versions (example). We currently compensate by skipping checking this file entirely, which means skipping the checking of possibly valid deprecation notices. |
|
Note: This is a temporary change. Once we migrate to JSR, I'll add a check that ensures deprecation notices contain a semver string. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change simplifies the deprecation notice check by making it just check whether a deprecation notice comes with a message. Deprecation notices have also been changed to no longer include brackets at the beginning of the sentence, which always seemed odd to me.
Previously, this check was stricter than it needed to be and has become a little outdated, given that the way we deprecate APIs is evolving.
The script execution time has reduced from ~5.6s to ~3.