Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs: describe the atomic patch write and the Latest release rule

Yudhi Armyndharis817ff25ced35
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4552a8628..cd91fbd35 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -263,7 +263,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Update only the supplied fields on `PUT /api/sessions/{sessionId}/templates/{id}` and answer 404 for a template deleted meanwhile, where an overlapping edit was undone or the template came back.
- Report a status whose row was removed while its media was written as not stored, and delete its file.
- Accept an empty `url` next to `base64` in status posts and media conversion.
-- Fail `npm install` when a dependency patch breaks off part-way while writing, such as on a full disk, instead of skipping it under `--best-effort` and leaving a truncated file.
+- Write each patched dependency file to a temporary file and rename it over the original, so a write that fails part-way, such as on a full disk, leaves the file unchanged; a best-effort patch is then skipped, and any other install fails instead of keeping a truncated file.
- Keep the `latest` and `X.Y` image tags from moving to an older release when an older tag is released or re-run.
- Create the GitHub Release from a notes file, so a CHANGELOG section containing a line that is exactly `EOF` no longer breaks it.
- Mirror the PHP SDK to `openwa-php` only from `main` and only while its content matches `main`, so a manual run from another branch or a re-run of an older push no longer replaces a newer mirror.
@@ -317,6 +317,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- The message list no longer answers an empty page when its `after` row is deleted while the page is being read.
- The message list reads its page rows by primary key on SQLite, which cuts a 100 row read of a 300k row session from about 70 ms to 5 ms.
- Fix the PHP SDK reading a `Retry-After` header of 309 or more digits as 0 seconds; it is now capped like a smaller oversized value.
+- Do not mark a patch release on an older line as the GitHub Latest release, which the update check reads.
### Dependencies
diff --git a/docs/15-project-roadmap.md b/docs/15-project-roadmap.md
index 37d4a1e91..f127b7683 100644
--- a/docs/15-project-roadmap.md
+++ b/docs/15-project-roadmap.md
@@ -743,6 +743,7 @@ flowchart TB
E --> G[promote: apply X.Y.Z, X.Y, latest to GHCR + Docker Hub]
F --> G
R --> G
+ R --> I
G --> H[verify-published: resolve every ref anonymously]
H --> I[GitHub Release, notes from the CHANGELOG section]
```
@@ -760,7 +761,9 @@ For a stable tag, `release-tags` reads which release `X.Y` and `latest` serve on
a channel alone when it already serves a newer one, so releasing a patch to an older line or re-running an
old tag never moves a channel backwards; the exact `X.Y.Z` tag is still applied. A channel it cannot read
fails the release rather than counting as absent; only the registry's own "manifest unknown" answer does.
-`verify-published` then expects only the tags `release-tags` selected.
+`verify-published` then expects only the tags `release-tags` selected. It also decides whether the GitHub
+Release is marked Latest: only when this release took every `latest` channel, never for a prerelease or a
+patch to an older line.
### When a gate fails