autorel 2.6.18 → 2.6.20

package/README.md

@@ -89,7 +89,7 @@ When autorel runs, it follows this sequence:
 4. **Run pre-release tasks** - Executes `preRun` scripts (tests, builds, etc.) if configured
 5. **Create git tag** - Tags the current commit with the new version
 6. **Create GitHub release** - Creates a release on GitHub with changelog (unless `--skip-release`)
-7. **Update package.json** - Updates version temporarily in memory (not committed to repo)
+7. **Update package.json** - Updates package.json "version" field locally (not an additional commit)
 8. **Publish to npm** - Publishes package if `--publish` is set
 9. **Restore package.json** - Immediately restores package.json to original version (always happens, even if publish fails)
 10. **Run post-release scripts** - Executes `run` scripts with `NEXT_VERSION` and `NEXT_TAG` environment variables
@@ -229,15 +229,17 @@ jobs:
 
 ### Using `--run` with the version in GitHub Actions
 
-**Only if you put `NEXT_VERSION` or `NEXT_TAG` in your `--run` command** (e.g. as an argument to your script), use a double dollar so the version is passed through. For example:
+When passing `$NEXT_VERSION` or `$NEXT_TAG` in your `--run` command, wrap the `--run` argument in **single quotes** so the shell doesn't expand the variable before autorel has a chance to set it:
 
 ```yaml
-- run: npx autorel@^2 --publish --run "deploy-service $$NEXT_VERSION"
+- run: npx autorel@^2 --publish --run 'deploy-service $NEXT_VERSION'
 ```
 
-In Actions the step `run:` is expanded by the runner *before* autorel runs, so a single `$` would be expanded when the variable is still unset. `$$` becomes a literal `$`, so the shell that runs your script gets `$NEXT_VERSION` after autorel has set it.
+With single quotes, `$NEXT_VERSION` is passed as a literal string to autorel. Autorel sets the environment variable and then executes your command in a sub-shell where it resolves correctly.
 
-You can also use `.autorel.yaml` or a script (e.g. `--run "./blah.sh"`); they run in a shell where the version is already set, so `$NEXT_VERSION` / `$NEXT_TAG` work as usual. `NEXT_TAG` is also available (e.g. for Docker tags that use `v`).
+> ⚠️ **Do not use double quotes** around the `--run` argument — the shell would expand `$NEXT_VERSION` to an empty string before autorel runs.
+
+You can also use `.autorel.yaml` or a wrapper script (e.g. `--run "./deploy.sh"`); they run in a shell where the version is already set, so `$NEXT_VERSION` / `$NEXT_TAG` work as usual.
 
 ## Authentication & Permissions
 
@@ -260,7 +262,7 @@ To publish packages to npm, you need authentication:
 ### About package.json Versions
 
 When using npm publishing, autorel:
-1. Temporarily updates `package.json` version in memory
+1. Updates `package.json` version locally (not commited)
 2. Publishes to npm with that version
 3. **Immediately restores** `package.json` to the original version (even if publish fails)
 4. Then runs post-release scripts (`--run`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "2.6.18",
+  "version": "2.6.20",
   "description": "Automate semantic releases based on conventional commits. Similar to semantic-release but much simpler.",
   "license": "MIT",
   "author": "Marc H. Weiner <mhweiner234@gmail.com> (https://mhweiner.com)",