Skip to content

docs: update shared docs during releases #664

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
zhongkechen wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update shared docs during releases #664

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78bcb2f
docs: update shared docs during releases
Aug 31, 2026
e5bd2aa
Merge branch 'main' into docs/update-release-docs-version
zhongkechen Sep 3, 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
44 changes: 44 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,47 @@ After **Publish Maven Release** succeeds:
4. Confirm that the GitHub release contains the expected JARs and that the
artifacts are available in Maven Central.
5. Review, approve, and merge the next development version pull request.

## 4. Update the shared documentation

After the artifacts are available in Maven Central, open a pull request in
[`aws/aws-durable-execution-docs`](https://github.com/aws/aws-durable-execution-docs)
that updates every literal Java SDK version to the release version without the
leading `v`.

For a prerelease, update the shared documentation only when that prerelease is
intended to become the recommended version. Otherwise, wait for the final
release.

At minimum, check the Java runtime and testing dependencies in:

- `docs/sdk-reference/languages/java/index.md`
- `docs/getting-started/quickstart.md`
- `docs/getting-started/quickstart-container-image.md`
- `docs/getting-started/development-environment.md`
- `docs/testing/authoring.md`

Search the entire documentation repository so new dependency snippets are not
missed:

```bash
rg -n -B2 -A2 \
'<artifactId>aws-durable-execution-sdk-java(-testing|-plugin-otel)?</artifactId>' \

@github-actions github-actions Bot Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex AI review · Finding arf_v1_uw2u4lsnnppg35j2rogdlshq6e

[P2] Search beyond Maven XML tags

Requiring an exact <artifactId> tag skips Gradle/Kotlin DSL, inline coordinates, and versioned plugin filenames, despite the checklist requiring every literal SDK version to be updated. Search for the artifact-name pattern itself so all dependency syntaxes are covered.

Suggested change
'<artifactId>aws-durable-execution-sdk-java(-testing|-plugin-otel)?</artifactId>' \
'aws-durable-execution-sdk-java(-testing|-plugin-otel)?' \

docs
```

Update literal versions for the runtime SDK, testing library, and OpenTelemetry
plugin when present. Do not change independently versioned dependencies such as
`aws-lambda-java-core`.

Run the documentation checks before opening the pull request:

```bash
mdformat --check docs/
codespell docs/
python3 scripts/check_example_refs.py
zensical build --clean
```

Link the Java GitHub release in the pull request description and merge the
documentation pull request after its required checks pass.
Loading