Skip to content

docs: update all docs and examples for v1.0.1 release#746

Merged
bnusunny merged 2 commits into
aws:mainfrom
JamBalaya56562:docs-update-v1.0.1
Jun 1, 2026
Merged

docs: update all docs and examples for v1.0.1 release#746
bnusunny merged 2 commits into
aws:mainfrom
JamBalaya56562:docs-update-v1.0.1

Conversation

@JamBalaya56562
Copy link
Copy Markdown
Contributor

Description

Updates documentation and examples for the v1.0.1 release, mirroring the 1.0.0 docs update in #689.

  • Docker image tag: public.ecr.aws/awsguru/aws-lambda-adapter:1.0.0:1.0.1 (README, user guide, Dockerfiles, example READMEs, examples.yaml CI workflow)
  • Lambda layer version: LambdaAdapterLayer{X86,Arm64}:27:28 (README, user guide, SAM templates, example READMEs, CDK app)

Verification

The commercial layer version :28 was confirmed against the actual v1.0.1 release run (sam deploy CloudFormation outputs), e.g. arn:aws:lambda:us-east-1:753240598075:layer:LambdaAdapterLayerX86:28 (verified consistent across the sampled commercial regions for both x86_64 and arm64).

The Docker tag is derived directly from CARGO_PKG_VERSION in the release workflow, so 1.0.1 is exact.

Note: the AWS China region ARNs are kept in lockstep with the commercial version per the existing docs convention. China prod layers are not deployed by the current release pipeline (the deploy-china-prod job is disabled), so their published version should be confirmed in the AWS China console if exactness is required.

Type of change

  • Documentation update

🤖 Generated with Claude Code

Bump the Docker image tag from 1.0.0 to 1.0.1 and the Lambda layer
version from 27 to 28 across the README, user guide, Dockerfiles, SAM
templates, and example READMEs, and add the v1.0.1 CHANGELOG section,
mirroring the 1.0.0 release update (aws#689).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@bnusunny bnusunny left a comment

Choose a reason for hiding this comment

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

Thanks for the update. I will automate this update via the release pipeline.

@bnusunny bnusunny merged commit f9cebb9 into aws:main Jun 1, 2026
21 checks passed
@JamBalaya56562 JamBalaya56562 deleted the docs-update-v1.0.1 branch June 1, 2026 23:36
JamBalaya56562 added a commit to JamBalaya56562/aws-lambda-web-adapter that referenced this pull request Jun 2, 2026
Automate the manual version-string sweep that PR aws#746 did by hand, per
the maintainer's note on that PR ("I will automate this update via the
release pipeline").

Two hard-coded references across docs/examples are kept in sync:
- Docker image tag public.ecr.aws/awsguru/aws-lambda-adapter:<X.Y.Z>
  (= the crate semver)
- Lambda layer version LambdaAdapterLayer{X86,Arm64}:<N> (an integer AWS
  assigns at publish time)

How:
- scripts/update-versions.sh <image_version> <layer_version>: a reusable,
  idempotent, anchored updater (skips CHANGELOG.md history and the obsolete
  commented example ARN, account 753240598076). Runnable by a human too.
- release-plz.yml: after release-plz opens/updates the Release PR, an
  inject step predicts the next layer version (current + 1) and the new
  image tag and amends them into the same release commit. The +1 prediction
  is reliable because the SAM layer's Description embeds the crate version,
  so every release publishes exactly one new immutable layer version.
- release.yaml: a post-deploy verify-layer-versions job reads the ACTUAL
  published layer version and opens a self-healing correction PR if the
  prediction was ever wrong. (Requires lambda:ListLayerVersions on the prod
  pipeline role; the prediction stands on its own without it.)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
JamBalaya56562 added a commit to JamBalaya56562/aws-lambda-web-adapter that referenced this pull request Jun 2, 2026
Automate the manual version-string sweep that PR aws#746 did by hand, per
the maintainer's note on that PR ("I will automate this update via the
release pipeline").

Two hard-coded references across docs/examples are kept in sync:
- Docker image tag public.ecr.aws/awsguru/aws-lambda-adapter:<X.Y.Z>
  (= the crate semver)
- Lambda layer version LambdaAdapterLayer{X86,Arm64}:<N> (an integer AWS
  assigns at publish time)

How:
- scripts/update-versions.sh <image_version> <layer_version>: a reusable,
  idempotent, anchored updater (skips CHANGELOG.md history and the obsolete
  commented example ARN, account 753240598076). Runnable by a human too.
- release-plz.yml: after release-plz opens/updates the Release PR, an
  inject step predicts the next layer version (current + 1) and the new
  image tag and amends them into the same release commit. The +1 prediction
  is reliable because the SAM layer's Description embeds the crate version,
  so every release publishes exactly one new immutable layer version.
- release.yaml: a post-deploy verify-layer-versions job reads the ACTUAL
  published layer version and opens a self-healing correction PR if the
  prediction was ever wrong. (Requires lambda:ListLayerVersions on the prod
  pipeline role; the prediction stands on its own without it.)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

2 participants