Repository navigation
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
hln33
force-pushed
the
docs/releasing-shared-docs-step
branch
from
October 31, 2026 00:20
effb9d8 to
7db356c
Compare
hln33
changed the title
This comment has been minimized.
This comment has been minimized.
The mdformat, codespell, check_example_refs, and zensical commands belong to aws/aws-durable-execution-docs. That repository documents them in its CONTRIBUTING.md and runs them in CI. So the release guide does not need to restate them.
hln33
force-pushed
the
docs/releasing-shared-docs-step
branch
from
October 31, 2026 00:23
7db356c to
944668f
Compare
Contributor
Codex AI reviewNo actionable findings after reviewing the complete diff against rules 1–9. This is a documentation-only change. No code was executed; external documentation links and command targets were not verified. Reviewed commit |
zhongkechen
approved these changes
Oct 31, 2026
This branch was successfully deployed
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.
Issue #, if available
Closes #878
Description of changes
Adds a
### 3. Update the shared documentationstep toRELEASING.mdunder "Cutting a Release", and an "After publishing a release" checklist item. The step assigns the review of aws/aws-durable-execution-docs to the release engineer for every release, covers API references, guides,examples/python/snippets, dependency versions, compatibility and migration text (not only version strings), gives a search command and the docs repo's checks, and asks the engineer to open or update the docs PR, link the release, and record "no changes needed" when applicable. Wording mirrors the existing section 4 of the Java SDKRELEASE.md. Sibling PRs: aws-durable-execution-sdk-js #1116, aws-durable-execution-sdk-java #843.Design
See Rules for every change.
Assumptions
mdformat --check docs/,codespell docs/,python3 scripts/check_example_refs.py,zensical build --clean. Evidence:.github/workflows/quality.yml,scripts/check_example_refs.pyandzensical.tomlon aws-durable-execution-docs main, and the same list in the Java SDKRELEASE.mdsection 4.Decisions not covered by the issue or the design note
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.