Skip to content

docs: update shared docs during releases - #664

Open
zhongkechen wants to merge 1 commit into
mainfrom
docs/update-release-docs-version
Open

docs: update shared docs during releases#664
zhongkechen wants to merge 1 commit into
mainfrom
docs/update-release-docs-version

Conversation

@zhongkechen

Copy link
Copy Markdown
Contributor

Summary

  • add a required post-publication step to update Java SDK versions in the shared docs repository
  • list the current runtime and testing dependency locations
  • include a repository-wide search that also catches OpenTelemetry plugin dependencies
  • document prerelease handling and the shared docs validation commands

Testing

  • codespell RELEASE.md
  • git diff --check
  • verified every listed shared-docs path exists
  • verified the documented rg command finds all current Java SDK dependency snippets

Maven tests were not run because this changes release documentation only.

@zhongkechen
zhongkechen requested a review from a team August 31, 2026 19:03
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime August 31, 2026 19:03 — with GitHub Actions Inactive
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime August 31, 2026 19:18 — with GitHub Actions Inactive
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime August 31, 2026 19:18 — with GitHub Actions Inactive
Comment thread RELEASE.md

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

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)?' \

@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

The new shared-doc release search can miss non-Maven dependency references, potentially leaving stale versions.

Reviewed commit 78bcb2f305db80cb459b6a87458fe3d17e741aa5. Workflow run

@github-actions

Copy link
Copy Markdown
Contributor

Claude AI review

This PR only adds a new "## 4. Update the shared documentation" section to RELEASE.md (44 additions, 0 deletions, no code changes). It documents a post-publication step to sync the Java SDK version into the separate aws-durable-execution-docs repository.

Review notes:

  • The rg pattern '<artifactId>aws-durable-execution-sdk-java(-testing|-plugin-otel)?</artifactId>' correctly matches all three published artifact IDs (aws-durable-execution-sdk-java, aws-durable-execution-sdk-java-testing, aws-durable-execution-sdk-java-plugin-otel), verified against sdk/pom.xml, sdk-testing/pom.xml, and otel-plugin/pom.xml.
  • Section numbering (## 4. following existing ## 1.## 3.), terminology ("runtime SDK, testing library, OpenTelemetry plugin"), and the "without a leading v" phrasing are consistent with the rest of RELEASE.md.
  • No code, tests, public API, checkpoint/replay, or concurrency logic is touched, so the SDK-focused review criteria (serialization, replay semantics, thread coordination, etc.) do not apply here. No tests are required for a docs-only change, consistent with CONTRIBUTING.md/AGENTS.md.

No code-level or correctness issues were found in this diff.

Residual risk: the new instructions reference file paths and tooling (docs/sdk-reference/..., mdformat, codespell, scripts/check_example_refs.py, zensical) that live in the separate aws-durable-execution-docs repository. None of these can be validated from within this repository, so their accuracy relies entirely on the PR author's manual verification described in the PR body; a future drift in that repo's structure or tooling would silently make these instructions stale.

Reviewed commit 78bcb2f305db80cb459b6a87458fe3d17e741aa5. Workflow run

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.

1 participant