Skip to content

Enhance code for displaying deprecation and sunset date in changelogs#783

Merged
reuvenharrison merged 9 commits intomainfrom
improve-deprecation-and-sunset-date-in-changelog
Jan 26, 2026
Merged

Enhance code for displaying deprecation and sunset date in changelogs#783
reuvenharrison merged 9 commits intomainfrom
improve-deprecation-and-sunset-date-in-changelog

Conversation

@reuvenharrison
Copy link
Collaborator

This PR fixes a few problems in #771

@codecov-commenter
Copy link

codecov-commenter commented Jan 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.78%. Comparing base (954d7d0) to head (e4096ef).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #783      +/-   ##
==========================================
+ Coverage   88.73%   88.78%   +0.05%     
==========================================
  Files         246      246              
  Lines       12201    12183      -18     
==========================================
- Hits        10826    10817       -9     
+ Misses        932      928       -4     
+ Partials      443      438       -5     
Flag Coverage Δ
unittests 88.78% <100.00%> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@reuvenharrison reuvenharrison changed the title type-safe formatDeprecationDetails Enhance code for displaying deprecation and sunset date in changelogs Jan 26, 2026
@reuvenharrison
Copy link
Collaborator Author

Hi @wwerner,
This PR fixes some problems in the original implementation - you are welcome to review.
One notable change is that the message now includes deprecation and sunset date in the same line rather than underneath as you originally implemented it , for example:

❯ oasdiff changelog data/deprecation/base-beta-stability.yaml  data/deprecation/deprecated-future-beta-stability.yaml
1 changes: 0 error, 0 warning, 1 info
info	[endpoint-deprecated] at data/deprecation/deprecated-future-beta-stability.yaml
	in API GET /api/test
		endpoint deprecated (sunset: 9999-08-10, stability: beta)

@reuvenharrison reuvenharrison merged commit 01f5fb1 into main Jan 26, 2026
14 checks passed
@reuvenharrison reuvenharrison deleted the improve-deprecation-and-sunset-date-in-changelog branch January 26, 2026 18:18
@wwerner
Copy link
Contributor

wwerner commented Jan 29, 2026

Amazing, thanks a ton! 🫶

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.

3 participants