Prepare 0.5.0 with audited upgrade and operations documentation - #14
Merged
Conversation
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
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.
Prepare 0.5.0 with documentation that matches the reviewed implementation and its remaining limits. The upgrade guidance now explains that Django can report no slug-field migration while an old physical index still exists; this was verified using the migration autodetector.
Update the README, changelog, contributing/release/security guidance, review status, API/test docstrings, and source-distribution manifest. Add operations, upgrade, and example-project guides. Correct backend coverage claims, explicit validation behavior, deterministic equality/rotation limitations, and recovery expectations for historical binary/timestamp corruption. The security contact now uses the maintainer email because private GitHub reporting is disabled. Release instructions distinguish signed tags from annotated unsigned tags; no signing identity is configured in the release environment.
Set the package and version regression to 0.5.0. Runtime behavior is unchanged in this preparation PR beyond the previously merged fixes; source changes are docstrings and the version.
Validation:
Release only after this PR and CI on its main-branch merge commit pass. Tag that exact commit, review the GitHub draft, publish through trusted publishing, and verify the exact version from PyPI in a clean environment.