Skip to content

RELEASE.md

Latest commit

 

History

History
109 lines (84 loc) · 4.29 KB

RELEASE.md

File metadata and controls

109 lines (84 loc) · 4.29 KB
Raw

Release Process

Releases use two GitHub Actions workflows with a manual approval boundary between them:

1. Prepare the release pull request

  1. Open Actions, select Prepare Maven Release, and choose Run workflow from the default branch.
  2. Enter the release version without a leading v, for example 2.1.1.
  3. Wait for the workflow to validate the release and open a pull request that updates all Maven POMs to the release version.
  4. Review, approve, and merge the release version pull request.

The preparation workflow validates that releases containing BREAKING changes increment the major version. It commits the version change to release/v<version> and stops after opening the pull request. It does not publish artifacts or create a GitHub release.

2. Create the GitHub release

After the release version pull request is merged:

  1. Open Releases and choose Draft a new release.
  2. Create the tag v<version>, for example v2.1.1, from the release version pull request's merge commit on the default branch.
  3. Set the title to Release v<version> and generate or enter the release notes.
  4. Mark the release as a prerelease when applicable.
  5. Publish the release.

Publishing the GitHub release emits the release.published event. This starts the Maven publication workflow and the release notification workflow.

3. Verify publication

The publication workflow:

  1. Verifies that the tag is a semantic version, points to a commit on the default branch, and matches the Maven version in the tagged POM.
  2. Builds, signs, and uploads the SDK, testing library, OpenTelemetry plugin, and Workflow Insight plugin to Sonatype Central Portal.
  3. Uploads the four JARs to the existing GitHub release.
  4. Opens a pull request for the next development version. A final release increments the patch version, so 2.1.1 produces 2.1.2-SNAPSHOT. A prerelease keeps the same base version, so 2.1.1-rc1 produces 2.1.1-SNAPSHOT until the final 2.1.1 release.

After Publish Maven Release succeeds:

  1. Open Publishing Deployments in Sonatype Central Portal.
  2. Find the deployments for the release version and verify that they contain the expected SDK, testing library, OpenTelemetry plugin, and Workflow Insight plugin artifacts.
  3. Click Publish for each deployment and wait for publication to complete. The workflow uses autoPublish=false, so this manual action is required.
  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 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:

rg -n -B2 -A2 \
  '<artifactId>aws-durable-execution-sdk-java(-testing|-plugin-otel)?</artifactId>' \
  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:

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.