@releasekit/publish 0.2.0-next.9 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sam Maister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -21,6 +21,8 @@ npm install -g @releasekit/publish
 pnpm add -g @releasekit/publish
 ```
 
+> **Note:** This package is ESM only and requires Node.js 20+.
+
 ## Quick Start
 
 `@releasekit/publish` reads JSON output from `@releasekit/version` and runs a publish pipeline:
@@ -82,13 +84,21 @@ releasekit-publish --input version-output.json
 ### In CI (GitHub Actions)
 
 ```yaml
+- name: Configure permissions (OIDC + git pushes)
+  # at job level:
+  # permissions:
+  #   id-token: write
+  #   contents: write
+
 - name: Version
   run: releasekit-version --json > version-output.json
 
 - name: Publish
   run: releasekit-publish --input version-output.json
+  # For OIDC trusted publishing: no npm token needed (recommended).
+  # For token-based publishing: set NPM_TOKEN (or NODE_AUTH_TOKEN).
   env:
-    NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 ## Configuration
@@ -105,6 +115,10 @@ Configure via `releasekit.config.json`:
       "access": "public",
       "copyFiles": ["LICENSE"]
     },
+    "git": {
+      "pushMethod": "auto",
+      "httpsTokenEnv": "GITHUB_TOKEN"
+    },
     "cargo": {
       "enabled": false,
       "noVerify": false