autorel 0.0.21 → 0.0.22

package/README.md

@@ -114,7 +114,7 @@ Whether to skip creating a release on GitHub. If `true`, the release will not be
 
 ## run
 
-A command to run after the release is complete. This will be run via `child_process`. The following environment variables are available:
+A command to run after the release is complete. The following environment variables are available:
 
 | Variable | Description |
 | --- | --- |
@@ -127,9 +127,9 @@ A command to run after the release is complete. This will be run via `child_proc
 
 ## runScript (YAML only)
 
-A bash script to run after the release is complete. This will be run via `bash` and `child_process`. Environment variables are available as above.
+A bash script to run after the release is complete. Environment variables are available as above.
 
-> This requires `bash` to be installed on the system.
+> ❗️ This requires `bash` to be installed on the system.
 
 You can use the multi-line string syntax in YAML to write a script:
 
@@ -142,14 +142,6 @@ runScript: |
 - Argument: `runScript: string`
 - Default: `undefined`
 
-## tag
-
-The tag to use for the release. This will be used verbatim, instead of being generated from the version number. Always results in a release being created unless `noRelease` is `true`. **Advanced usage only.**
-
-- CLI: `--tag`
-- Argument: `tag: string`
-- Default: `undefined`
-
 ## pre-release
 
 The pre-release channel to use. This will be appended to the version number. For example, if the version is `1.0.0` and the pre-release is `alpha`, the version will be `1.0.0-alpha.1`. For "production" releases, leave this blank. In this case, "latest" will be used for the NPM tag/channel.
@@ -192,6 +184,16 @@ The above will release to the `latest` channel (production) on NPM for the `main
 
 - Argument: `branches: ReleaseBranch[]`
 
+## useVersion
+
+The version to use for the release INSTEAD of the version being generated. Always results in a release being created unless `noRelease` is `true`. **Advanced usage only, not recommended for most users.**
+
+- CLI: `--use-version`
+- Argument: `useVersion: string`
+- Default: `undefined`
+
+> ❗️ Must be a valid SemVer version, without the `v`.
+
 # Sample YAML Configuration
 
 <sub>_.autorel.yaml_</sub>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "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)",