feat: Display deprecation and sunset date in changelogs#771
Merged
reuvenharrison merged 6 commits intooasdiff:mainfrom Jan 25, 2026
Merged
feat: Display deprecation and sunset date in changelogs#771reuvenharrison merged 6 commits intooasdiff:mainfrom
reuvenharrison merged 6 commits intooasdiff:mainfrom
Conversation
Add optional display of sunset date and stability level for deprecated
endpoints and parameters in changelogs. Details are only shown when
values are present, avoiding empty parentheses.
Changes:
- Add formatDeprecationDetails() helper to conditionally format
deprecation metadata (sunset date, stability level)
- Fix bug where deprecations without sunset dates were not appearing
in changelogs when no deprecation policy is defined
- Update deprecation checkers to pass formatted details via Comment field
- Update changelog templates (markdown and HTML) to display comments
- Update formatters to preserve formatted comments without localization
- Update localization messages to work with new comment-based approach
- Update tests to use Contains() assertions for flexible text matching
Example outputs:
- Without details: "endpoint deprecated"
- With sunset: "endpoint deprecated (sunset: 2025-11-10)"
- With both: "endpoint deprecated (sunset: 2025-11-10, stability: alpha)"
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #771 +/- ##
==========================================
- Coverage 88.73% 88.73% -0.01%
==========================================
Files 246 246
Lines 12144 12201 +57
==========================================
+ Hits 10776 10826 +50
- Misses 930 932 +2
- Partials 438 443 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
reuvenharrison
added a commit
that referenced
this pull request
Jan 6, 2026
Collaborator
|
Hi @wwerner,
|
Contributor
Author
|
Hey @reuvenharrison, thanks a ton for having a look. Will get back to you with proper tests. 🙏 |
…ation_display feat: add unit tests for changelog deprecation display with conditional details
Contributor
|
Hey @reuvenharrison. I just pushed the tests. But it seems like the codecov-commenter does not get retriggered. Can you help me out here? Thanks a lot! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Add optional display of sunset date and stability level for deprecated
endpoints and parameters in changelogs. Details are only shown when
values are present.
Changes:
deprecation metadata (sunset date, stability level)
Example outputs: