Skip to content

Commit c9df6ce

Browse files
docs: replace regular release section with manual release
1 parent b409be6 commit c9df6ce

1 file changed

Lines changed: 35 additions & 24 deletions

File tree

‎README-LOCALSTACK.md‎

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -45,30 +45,6 @@ Releases are cut from the `localstack` branch (not `main`/`develop`, which mirro
4545
The resulting binaries are consumed by localstack-pro via `LAMBDA_INIT_RELEASE_VERSION=<tag>` and
4646
by lambda-images.
4747

48-
### Regular release
49-
50-
Regular releases are **automated**: pushing a version tag on `localstack` triggers the
51-
[`build.yml`](./.github/workflows/build.yml) workflow, which runs the tests, builds the binaries
52-
(`make compile-lambda-linux-all`), and publishes a GitHub release with auto-generated release notes
53-
and the `bin/*` binaries attached. Versioning follows `vX.Y.Z` (e.g. `v0.2.0`), continuing from the
54-
previous release (e.g. [`v0.1.47`](https://github.com/localstack/lambda-runtime-init/releases/tag/v0.1.47)).
55-
56-
1. Create a **lightweight** tag for the new version, on the commit you want to release. Match the
57-
prior convention
58-
```bash
59-
git tag v0.2.0
60-
```
61-
2. Push the tag to trigger the release build:
62-
```bash
63-
git push origin v0.2.0
64-
```
65-
`build.yml` matches the `v*.*` tag pattern and publishes the release automatically. A tag ending
66-
in `-pre` is published as a pre-release.
67-
68-
> The `.github/workflows/release.yml` ("Release") workflow is **legacy** and is not used for
69-
> LocalStack releases — it is a manual `workflow_dispatch` that checks out `main` (the upstream
70-
> mirror) rather than `localstack`, so it would not include the LocalStack customizations.
71-
7248
### Weekly auto-release
7349

7450
[`weekly-release.yml`](./.github/workflows/weekly-release.yml) runs every Friday at 06:00 UTC. If
@@ -88,6 +64,41 @@ The release is published as a **pre-release**, and only reaches consumers once i
8864
Run it manually via the **Weekly Release** workflow (`workflow_dispatch`); `dryRun` reports the next
8965
version without releasing. A failed run posts to Slack.
9066

67+
### Manual release
68+
69+
Most releases come from the weekly auto-release above. Cut one by hand only when you need:
70+
71+
- a **minor or major** version bump (the weekly release only bumps the patch version), or
72+
- an **urgent fix** that can't wait for the next Friday run.
73+
74+
Pushing a version tag on `localstack` triggers [`build.yml`](./.github/workflows/build.yml), which
75+
runs the tests, builds the binaries (`make compile-lambda-linux-all`), and publishes a GitHub release
76+
with auto-generated release notes and the `bin/*` binaries attached.
77+
78+
1. Create a tag on the commit you want to release, continuing from the latest release
79+
(see [releases](https://github.com/localstack/lambda-runtime-init/releases)):
80+
```bash
81+
git tag v0.4.0
82+
```
83+
2. Push the tag to trigger the release build:
84+
```bash
85+
git push origin v0.4.0
86+
```
87+
88+
> ⚠️ A manual release is published as a **full release** right away. It skips the localstack-pro
89+
> validation that gates weekly releases, so lambda-images picks it up immediately. To keep the gate,
90+
> mark it as a pre-release once it's published and let localstack-pro promote it:
91+
> ```bash
92+
> gh release edit v0.4.0 --prerelease
93+
> ```
94+
95+
The next weekly run patch-bumps from the highest `vX.Y.Z` release, so after `v0.4.0` it releases
96+
`v0.4.1`.
97+
98+
> The `.github/workflows/release.yml` ("Release") workflow is **legacy** and is not used for
99+
> LocalStack releases. It is a manual `workflow_dispatch` that checks out `main` (the upstream
100+
> mirror) rather than `localstack`, so it would not include the LocalStack customizations.
101+
91102
### RC (release candidate) pre-release
92103
93104
RC pre-releases let an **unmerged** PR be tested against localstack-pro CI without cutting a real

0 commit comments

Comments
 (0)