@omnidist/omnidist 0.1.20 → 0.1.21

package/README.md

@@ -81,7 +81,15 @@ This creates:
 - `.omnidist/` workspace directories
 - `.omnidist/.gitignore` for generated artifacts
 
-3. Build binaries for configured targets:
+3. Edit config and set environment variables (optional):
+
+```bash
+$EDITOR .omnidist/omnidist.yaml
+```
+
+`omnidist` loads `.env` automatically when present, so you can keep values like `OMNIDIST_VERSION`, `NPM_PUBLISH_TOKEN`, and `UV_PUBLISH_TOKEN` there.
+
+4. Build binaries for configured targets:
 
 ```bash
 omnidist build
@@ -89,7 +97,7 @@ omnidist build
 
 This also writes the resolved build version to `.omnidist/dist/VERSION`.
 
-4. Stage and verify artifacts:
+5. Stage and verify artifacts:
 
 ```bash
 omnidist stage
@@ -100,18 +108,21 @@ omnidist verify
 `.omnidist/uv/pyproject.toml` with that version.
 It also recreates `.omnidist/uv/dist` to prevent stale wheel artifacts from previous runs.
 
-5. Publish when verification passes:
+6. Publish when verification passes:
 
 ```bash
 omnidist publish
 ```
 
-6. Generate tag-triggered release workflow:
+7. Generate tag-triggered release workflow:
 
 ```bash
 omnidist ci
 ```
 
+The generated workflow publishes npm and uv artifacts and also creates a GitHub
+release with the built cross-platform binaries plus `checksums.txt`.
+
 ## Common Commands
 
 ```bash
@@ -152,7 +163,7 @@ omnidist uv publish --publish-url https://test.pypi.org/legacy/ --token <pypi-to
 
 Supported variables:
 
-- `OMNIDIST_VERSION`: used when `version.source: env`; also expanded in `build.ldflags` templates (for example `${OMNIDIST_VERSION}`).
+- `OMNIDIST_VERSION`: used only when `version.source: env`; also expanded in `build.ldflags` templates (for example `${OMNIDIST_VERSION}`).
   `VERSION` is not used.
 - `OMNIDIST_GIT_COMMIT`: optional ldflags template variable for build metadata; populated automatically by `omnidist build` when git metadata is available.
 - `OMNIDIST_BUILD_DATE`: optional ldflags template variable for build metadata; populated automatically by `omnidist build` as UTC RFC3339.
@@ -177,7 +188,9 @@ tool:
   main: ./cmd/omnidist
 
 version:
-  source: git-tag # git-tag | file | env
+  source: git-tag # git-tag | file | env | fixed
+  file: VERSION # optional; used when source is file (default VERSION)
+  fixed: 1.2.3 # required when source is fixed
 
 targets:
   - os: darwin
@@ -201,6 +214,7 @@ distributions:
     package: "@omnidist/omnidist"
     registry: https://registry.npmjs.org
     access: public # public | restricted
+    license: MIT # optional override for package.json license; omit to use SEE LICENSE IN <file>
     include-readme: true # include project README.md in staged packages when present
 
   uv:
@@ -221,6 +235,16 @@ build:
 
 With `version.source: git-tag`, release workflows require `HEAD` to be on an exact SemVer tag (`vX.Y.Z` or `X.Y.Z`).
 
+With `version.source: file`, omnidist reads `./VERSION` from the repository root.
+
+With `version.source: file`, you can override the path via `version.file` (for example `versions/release.txt`).
+
+With `version.source: fixed`, set `version.fixed` to an exact value in config (for example `1.2.3`).
+
+With `version.source: env`, set `OMNIDIST_VERSION` (for example in `.env`) before build/stage/publish.
+
+Use global `--omnidist-root <path>` to set the project root for a command. Omnidist resolves it to an absolute path at startup and changes working directory to it before loading `.env` and config.
+
 ## Command Reference
 
 Top-level:
@@ -290,7 +314,8 @@ omnidist ci
 ```
 
 The generated workflow triggers on `v*` tag pushes and runs:
-`build -> stage -> verify -> publish`.
+`build -> stage -> verify -> publish`, then publishes the built binaries and
+checksums to the GitHub release.
 
 If workflow already exists:
 

package/package.json

@@ -14,11 +14,11 @@
   "license": "SEE LICENSE IN LICENSE",
   "name": "@omnidist/omnidist",
   "optionalDependencies": {
-    "@omnidist/omnidist-darwin-arm64": "0.1.20",
-    "@omnidist/omnidist-darwin-x64": "0.1.20",
-    "@omnidist/omnidist-linux-arm64": "0.1.20",
-    "@omnidist/omnidist-linux-x64": "0.1.20",
-    "@omnidist/omnidist-win32-x64": "0.1.20"
+    "@omnidist/omnidist-darwin-arm64": "0.1.21",
+    "@omnidist/omnidist-darwin-x64": "0.1.21",
+    "@omnidist/omnidist-linux-arm64": "0.1.21",
+    "@omnidist/omnidist-linux-x64": "0.1.21",
+    "@omnidist/omnidist-win32-x64": "0.1.21"
   },
-  "version": "0.1.20"
+  "version": "0.1.21"
 }