Repository navigation
docs: remind release engineers to update shared docs after each release - #845
Merged
Merged
Conversation
hln33
marked this pull request as ready for review
October 29, 2026 23:26
hln33
temporarily deployed
to
ai-pr-review-runtime
October 29, 2026 23:26 — with
GitHub Actions
Inactive
hln33
temporarily deployed
to
ai-pr-review-runtime
October 29, 2026 23:27 — with
GitHub Actions
Inactive
Contributor
Codex AI reviewNo actionable findings in this documentation-only change after checking the applicable rules and SDK invariants. Residual risk: external documentation paths and commands were not independently validated; no repository code was executed. Reviewed commit |
zhongkechen
approved these changes
Oct 29, 2026
This branch was previously 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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Issue Link, if available
Closes #843
Description
Expands section 4 "Update the shared documentation" of
RELEASE.md. The section now assigns the review of aws/aws-durable-execution-docs to the release engineer for every release and adds an explicit checklist covering API references, guides,examples/java/snippets, literal versions, dependency versions, compatibility and migration text (not only version strings). It keeps the existing file list, version search and docs checks, adds a second search for the artifact id andsoftware.amazon.lambda.durablepackage prefix acrossdocsandexamples/java, and asks the engineer to open or update the docs PR, link the release, and record "no changes needed" when applicable. Sibling PRs: aws-durable-execution-sdk-js #1116, aws-durable-execution-sdk-python #878.Demo/Screenshots
N/A — documentation only.
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; these were already listed in the previous section 4.aws-durable-execution-sdk-java*and package prefixsoftware.amazon.lambda.durable. Evidence:rgover the docs repodocs/directory.Decisions not covered by the issue or the design note
Checklist
Testing
Unit Tests
N/A — documentation only.
Integration Tests
N/A — documentation only.
Examples
N/A.