Skip to content

docs: update shared docs during releases - #664

Open
zhongkechen wants to merge 2 commits into
mainfrom
docs/update-release-docs-version
Open

docs: update shared docs during releases#664
zhongkechen wants to merge 2 commits 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

This comment has been minimized.

@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Claude AI review

This PR only adds a new "## 4. Update the shared documentation" section to RELEASE.md, describing the manual step of updating the external aws-durable-execution-docs repo after a release publishes to Maven Central. No SDK source, tests, or public API surfaces are touched, so the checkpoint/replay, concurrency, and lifecycle review focus areas are not applicable here.

Verification performed:

  • Confirmed the rg search pattern <artifactId>aws-durable-execution-sdk-java(-testing|-plugin-otel)?</artifactId> correctly matches the three published artifact IDs (aws-durable-execution-sdk-java, aws-durable-execution-sdk-java-testing, aws-durable-execution-sdk-java-plugin-otel) as declared in sdk/pom.xml, sdk-testing/pom.xml, and otel-plugin/pom.xml, and correctly excludes the unrelated parent aggregator artifact aws-durable-execution-sdk-java-parent.
  • Checked the new section's placement and numbering against the existing ## 1/## 2/## 3 steps in RELEASE.md; the flow (prepare → release → verify publication → update shared docs) is logically consistent, and the prerelease-handling guidance is a sensible addition.
  • No broken internal links, no changes to code, build files, or tests, matching the doc-only scope declared in the PR description.

No correctness issues found. Residual risk is limited to unverifiable claims about the external aws-durable-execution-docs repository (that the five listed paths exist and that mdformat/codespell/check_example_refs.py/zensical commands behave as documented there), which cannot be checked from this repository and are asserted only by the PR author's testing notes.

Reviewed commit e5bd2aa041b479c24761b35eca56270280d382c4. 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