Skip to content

Commit 74e6fb5

Browse files
Document the weekly auto-release and promotion flow
1 parent 0f5e878 commit 74e6fb5

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README-LOCALSTACK.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,25 @@ previous release (e.g. [`v0.1.47`](https://github.com/localstack/lambda-runtime-
6969
> LocalStack releases — it is a manual `workflow_dispatch` that checks out `main` (the upstream
7070
> mirror) rather than `localstack`, so it would not include the LocalStack customizations.
7171
72+
### Weekly auto-release
73+
74+
[`weekly-release.yml`](./.github/workflows/weekly-release.yml) runs every Friday at 06:00 UTC. If
75+
`localstack` has new commits since the highest existing release, it patch-bumps the version and calls
76+
`build.yml` to run the tests, build the binaries, push the tag, and publish the release. Together with
77+
Renovate automerge, this is what carries dependency and CVE fixes downstream without manual work.
78+
79+
The release is published as a **pre-release**, and only reaches consumers once it has been validated:
80+
81+
1. `weekly-release.yml` publishes `vX.Y.Z`, marked as a pre-release.
82+
2. localstack-pro opens a PR bumping `LAMBDA_RUNTIME_DEFAULT_VERSION` to that version; its CI is the
83+
quality gate.
84+
3. On merge, localstack-pro flips the same release to a full release through the GitHub API — no new
85+
tag and no rebuild, so the binaries that were validated are the binaries that ship.
86+
4. lambda-images ignores pre-releases, so Renovate only opens a bump PR there after the promotion.
87+
88+
Run it manually via the **Weekly Release** workflow (`workflow_dispatch`); `dryRun` reports the next
89+
version without releasing. A failed run posts to Slack.
90+
7291
### RC (release candidate) pre-release
7392

7493
RC pre-releases let an **unmerged** PR be tested against localstack-pro CI without cutting a real

0 commit comments

Comments
 (0)