From bedb0cf32c750f88fdadebd6fb35545b205a7f40 Mon Sep 17 00:00:00 2001 From: Harry Nguyen Date: Thu, 29 Oct 2026 16:08:36 -0700 Subject: [PATCH 1/2] docs: add shared-docs reminder to release guide (#878) --- RELEASING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/RELEASING.md b/RELEASING.md index e0b4d6750..5535a8efd 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -203,6 +203,41 @@ Combined tags such as `sdk-v1.6.0,otel-v0.3.0` match the `sdk-v*` pattern becaus the full tag name starts with that prefix; the comma-separated parts are not separate Git tags. +### 3. Update the shared documentation + +The release engineer owns this step for every new version release. Complete it +after the published packages are available on PyPI. + +The shared documentation lives in +[`aws/aws-durable-execution-docs`](https://github.com/aws/aws-durable-execution-docs). +Checking version strings alone is insufficient. Review the changes in every +package released, including the OTel and testing packages when applicable, and +update the documentation to match: + +- [ ] API references and guides that describe new or changed behavior +- [ ] `examples/python/` snippets that use new or changed APIs +- [ ] Dependency versions, compatibility guidance, and migration instructions + +Search the entire documentation repository so references are not missed: + +```bash +rg -n 'aws-durable-execution-sdk-python' docs examples/python +``` + +Run the documentation checks before opening the pull request: + +```bash +mdformat --check docs/ +codespell docs/ +python3 scripts/check_example_refs.py +zensical build --clean +``` + +Open or update the documentation pull request, link this GitHub release in its +description, and follow through on review and merge. If the release needs no +documentation changes, add a note to the GitHub release stating that the +documentation review was completed and found no changes needed. + ## How Publishing Works Creating a GitHub Release triggers the [`pypi-publish.yml`](.github/workflows/pypi-publish.yml) workflow automatically. The workflow: @@ -335,3 +370,7 @@ Before publishing a release: - [ ] Release notes written with separate sections per package - [ ] Tag follows the naming convention (`sdk-vX.Y.Z`, `otel-vX.Y.Z`, `testing-vX.Y.Z`, `telemetry-exporter-vX.Y.Z`, or comma-separated) + +After publishing a release: + +- [ ] Shared documentation reviewed per [Update the shared documentation](#3-update-the-shared-documentation), and the docs pull request opened or "no documentation changes needed" recorded on the release From 944668f1d2cb955997bf1886b6742c6e91f270c8 Mon Sep 17 00:00:00 2001 From: Harry Nguyen Date: Fri, 30 Oct 2026 17:02:33 -0700 Subject: [PATCH 2/2] docs: drop docs-repo check commands from release guide 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. --- RELEASING.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 5535a8efd..3a54f80bd 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -224,15 +224,6 @@ Search the entire documentation repository so references are not missed: rg -n 'aws-durable-execution-sdk-python' docs examples/python ``` -Run the documentation checks before opening the pull request: - -```bash -mdformat --check docs/ -codespell docs/ -python3 scripts/check_example_refs.py -zensical build --clean -``` - Open or update the documentation pull request, link this GitHub release in its description, and follow through on review and merge. If the release needs no documentation changes, add a note to the GitHub release stating that the