aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authoruser <user@clank>2026-08-08 21:24:00 +0200
committeruser <user@clank>2026-08-08 21:24:00 +0200
commit51ee9ba249ed5147defe10e1c08296880e59526f (patch)
tree5ecba51bd00bff94fa1e5a5b1957dec660268c02 /README.md
parentdocs: prepend sl0ppij fork header to README (diff)
downloadsl0ppij-51ee9ba249ed5147defe10e1c08296880e59526f.tar.gz
sl0ppij-51ee9ba249ed5147defe10e1c08296880e59526f.tar.xz
sl0ppij-51ee9ba249ed5147defe10e1c08296880e59526f.zip
sl0p: tag fork builds as 0.45.0+sl0p1
`zellij --version` was identical to upstream, so there was no way to tell a fork binary from a stock one. Uses BUILD METADATA (+sl0p1) rather than a prerelease (-sl0p1): cargo ignores build metadata when matching version requirements, so the intra-workspace `zellij-utils = "0.45.0"` dependencies still resolve. The prerelease form was tried first and fails to resolve - it would require updating every member manifest to depend on the exact prerelease. Checked against the places VERSION is actually consumed: - shared::version_number() yields 4500 for both 0.45.0 and 0.45.0+sl0p1, so terminal version reporting is byte-identical, and still orders below 0.46.0. - client/server compatibility keys off CLIENT_SERVER_CONTRACT_VERSION, not this, so existing sessions are unaffected. - ZELLIJ_PLUGIN_ARTIFACT_DIR is keyed by VERSION, so the bundled wasm plugins are recompiled once on first run after a bump. One-time, harmless. Baselines held: zellij-server 1421/30, zellij-utils 435/5.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 369f2271..f0e4e117 100644
--- a/README.md
+++ b/README.md
@@ -90,6 +90,25 @@ the fork — check against `upstream/main` before chasing one).
use for them and adding proto fields would mean regenerating the committed prost
assets in `zellij-utils/assets/prost/`.
+## Version string
+
+Fork builds report a `+sl0pN` build-metadata suffix, so `zellij --version` is
+distinguishable from upstream:
+
+```
+$ zellij --version
+zellij 0.45.0+sl0p1
+```
+
+Build metadata rather than a `-sl0pN` prerelease on purpose: cargo ignores build
+metadata when matching version requirements, so the intra-workspace
+`zellij-utils = "0.45.0"` dependencies still resolve. A prerelease suffix does not,
+and would require editing every member manifest.
+
+Bump the suffix per published fork build; reset to 1 when rebasing onto a new
+upstream release. Note that a version bump changes `ZELLIJ_PLUGIN_ARTIFACT_DIR`, so
+the bundled wasm plugins are recompiled once on first run.
+
## Staying current with upstream
```