docs: an upgrade note for the unified TTL defaults - #25
Merged
Merged
Conversation
The squash merge of #22 dropped the breaking-change footer its commits carried, so release-please read the release as a patch and the changelog would not have mentioned the change in defaults. This restores the note and gives the constants their values in the user guide, with the line to add to keep the old behaviour. BREAKING CHANGE: DEFAULT_TTL_MINUTES is 60 (was 30) and MAX_TTL_SECONDS is 2592000 (was 86400), so IdempotencyDomainService() built without arguments now keeps records for an hour and accepts a TTL of up to 30 days. Pass default_ttl_minutes=30 and max_ttl_seconds=86400 to keep the old values.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
#22 made
core/constants.pythe single source for the TTL defaults, which moved two of them: the default TTL from 30 minutes to 60, and the ceiling from a day to thirty. Its commit said so with aBREAKING CHANGE:footer, and the squash merge threw the footer away because the squash message was the pull request title with an empty body. My mistake, not the author's.The result is visible in the open release pull request: release-please read the merge as a plain
fix:and proposed 0.1.2, with nothing in the changelog about a service built with no arguments now keeping records twice as long.This puts the footer back, so the pending release recomputes as a minor with a breaking-changes section. The change earns its place in the docs too: the constants section listed the three names without their values, which is the one thing a reader wants from it. It now gives the numbers, says the settings model takes its defaults from the same place, and carries the upgrade paragraph with the exact keywords to pass to keep the old behaviour.
Signature checked rather than remembered:
IdempotencyDomainService(*, default_ttl_minutes=60, min_ttl_seconds=60, max_ttl_seconds=2592000).