Skip to content

docs: add shared-docs reminder to release guide #881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hln33 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add shared-docs reminder to release guide #881

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bedb0cf
docs: add shared-docs reminder to release guide (#878)
hln33 Oct 29, 2026
944668f
docs: drop docs-repo check commands from release guide
hln33 Oct 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,32 @@ 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
```

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:
Expand Down Expand Up @@ -335,3 +361,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
Loading