Add changelog and migration guide for hardening releases#299
Merged
Conversation
MTrab
force-pushed
the
codex/docs-migration-guide
branch
from
e0a0cd2 to
6e4eb7a
Compare
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.
Summary
Adds baseline release documentation for the merged hardening work, including migration guidance for integrators and a maintained changelog structure.
Changes
CHANGELOG.mdwith anUnreleasedsection for merged hardening changes.MIGRATION.mddescribing integration-impacting behavior changes (disconnect lifecycle, HTTP error mapping, command serialization, timeout handling).README.mdwith links toMIGRATION.mdandCHANGELOG.md.Testing
Notes
#294,#295, and#296.masteras default branch; PR is opened againstmaster.