Skip to content

docs: remind release engineers to update shared docs after each release - #845

Merged
zhongkechen merged 1 commit into
mainfrom
docs/releasing-shared-docs-step
Oct 30, 2026
Merged

zhongkechen merged 1 commit into
mainfrom
docs/releasing-shared-docs-step

Conversation

@hln33

@hln33 hln33 commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

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 and software.amazon.lambda.durable package prefix across docs and examples/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.

  • Design note (rule 3): not needed — documentation-only change to the human release process.
  • Simpler options considered (rule 2): a single sentence added to the existing section. Rejected because the issue asks for an explicit checklist covering behavior and examples.
  • Root cause (rule 5): not a bug fix.
  • Net change in source lines and in public API members: 0 source lines, 0 API members. RELEASE.md only.

Assumptions

  • The docs repository's checks are mdformat --check docs/, codespell docs/, python3 scripts/check_example_refs.py, zensical build --clean. Evidence: .github/workflows/quality.yml, scripts/check_example_refs.py and zensical.toml on aws-durable-execution-docs main; these were already listed in the previous section 4.
  • Docs reference the SDK by artifact id aws-durable-execution-sdk-java* and package prefix software.amazon.lambda.durable. Evidence: rg over the docs repo docs/ directory.

Decisions not covered by the issue or the design note

  • Kept the prerelease guidance and the "do not change independently versioned dependencies" note from the previous section unchanged, because the issue asks to expand the section, not replace its existing guidance.

Checklist

  • I have filled out every section of the PR template
  • I have thoroughly tested this change — N/A, documentation only; rendered Markdown reviewed
  • Every new branch has a test that fails without it (rule 4) — N/A
  • For a bug fix: the description or commit order shows the regression test failing before the fix and passing after it (rule 5) — N/A
  • Every edited test expectation is listed in the description, with the reason (rule 5) — N/A

Testing

Unit Tests

N/A — documentation only.

Integration Tests

N/A — documentation only.

Examples

N/A.

@hln33
hln33 marked this pull request as ready for review October 29, 2026 23:26
@hln33
hln33 requested a review from a team October 29, 2026 23:26
@hln33
hln33 temporarily deployed to ai-pr-review-runtime October 29, 2026 23:26 — with GitHub Actions Inactive
@hln33
hln33 temporarily deployed to ai-pr-review-runtime October 29, 2026 23:27 — with GitHub Actions Inactive
@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

No 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 25b832aa4b932377eb9db6d41d6f95f39a4e4dd5. Workflow run

@zhongkechen
zhongkechen merged commit e3e56db into main Oct 30, 2026
30 checks passed
@zhongkechen
zhongkechen deleted the docs/releasing-shared-docs-step branch October 30, 2026 18:04

This branch was previously deployed

1 inactive deployment
ai-pr-review-runtime — 25b832aa Deployed Oct 29, 2026 by hln33 via ai-pr-review / Codex review / Generate Codex review #2755
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Remind release engineers to update shared docs after each release

2 participants