autorel 0.0.20 → 0.0.22

package/README.md

@@ -30,11 +30,12 @@ Autorel automatically does the following, if appropriate:
 **💪 Flexible & Powerful**
 - Use via `npx`, or import as a library
 - If using CLI, supports both `yaml` configuration and arguments
+- Highly customizable without being overly complex
 
 # Example Usage (CLI)
 
 ```bash
-npx autorel --publish --run "echo 'Hello, World!'"
+npx autorel --publish --run "echo \"Next version is ${NEXT_VERSION}!\""
 ```
 
 This will:
@@ -42,13 +43,13 @@ This will:
 1. Bump the version based on the commit messages since the last release (including pushing the tag and updating package.json)
 2. Create a new release on GitHub with Release Notes
 3. Publish the release to NPM
-4. Run the command `echo 'Hello, World!'`
+4. Run the command `echo "Next version is ${NEXT_VERSION}!"`
 
 You can also install `autorel` globally and run it that way:
 
 ```bash
 npm i -g autorel
-autorel --publish --run "echo 'Hello, World!'"
+autorel --publish
 ```
 
 # Example Usage (Library)
@@ -113,7 +114,12 @@ 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`.
+A command to run after the release is complete. The following environment variables are available:
+
+| Variable | Description |
+| --- | --- |
+| `NEXT_VERSION` | The next version number (without the `v`) |
+| `NEXT_TAG` | The next tag |
 
 - CLI: `--run`
 - Argument: `run: string`
@@ -121,12 +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`.
-
-- Argument: `runScript: string`
-- Default: `undefined`
+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:
 
@@ -136,12 +139,7 @@ runScript: |
   echo 'Goodbye, World!' > goodbye.txt
 ```
 
-## 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`
+- Argument: `runScript: string`
 - Default: `undefined`
 
 ## pre-release
@@ -186,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/dist/index.js

@@ -38,7 +38,7 @@ const github = __importStar(require("./services/github"));
 const output_1 = __importDefault(require("./lib/output"));
 const config_1 = require("./config");
 const versionBump_1 = require("./versionBump");
-const bash_1 = require("./lib/bash");
+const sh_1 = require("./lib/sh");
 function getPrereleaseChannel(args) {
     if (args.prereleaseChannel)
         return args.prereleaseChannel;
@@ -117,7 +117,7 @@ async function autorel(args) {
         output_1.default.log(args.run);
         output_1.default.log('----------------------------');
         output_1.default.log('');
-        (0, bash_1.cmd)(args.run);
+        (0, sh_1.cmd)(args.run);
     }
     else if (args.runScript) {
         output_1.default.log('Running post-release bash script:');
@@ -126,7 +126,7 @@ async function autorel(args) {
         output_1.default.log(args.runScript);
         output_1.default.log('----------------------------');
         output_1.default.log('');
-        (0, bash_1.bash)(args.runScript);
+        (0, sh_1.bash)(args.runScript);
     }
 }
 exports.autorel = autorel;

package/dist/lib/git.js

@@ -1,18 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCurrentBranch = exports.getCommitsSinceLastTag = exports.getRepo = exports.getLastProdTag = exports.getLastTag = exports.createAndPushTag = void 0;
-const bash_1 = require("./bash");
+const sh_1 = require("./sh");
 function createAndPushTag(tag) {
-    (0, bash_1.$) `git tag ${tag}`;
-    (0, bash_1.$) `git push origin ${tag}`;
+    (0, sh_1.$) `git tag ${tag}`;
+    (0, sh_1.$) `git push origin ${tag}`;
 }
 exports.createAndPushTag = createAndPushTag;
 function getLastTag() {
-    return (0, bash_1.$) `git tag | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+' | sort -V | tail -n 1` || '';
+    return (0, sh_1.$) `git tag | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+' | sort -V | tail -n 1` || '';
 }
 exports.getLastTag = getLastTag;
 function getLastProdTag() {
-    return (0, bash_1.$) `git tag --list | grep -E "^v[0-9]+\\.[0-9]+\\.[0-9]+$" | sort -V | tail -n 1` || '';
+    return (0, sh_1.$) `git tag --list | grep -E "^v[0-9]+\\.[0-9]+\\.[0-9]+$" | sort -V | tail -n 1` || '';
 }
 exports.getLastProdTag = getLastProdTag;
 function getRepo() {
@@ -20,7 +20,7 @@ function getRepo() {
         const [owner, repository] = process.env.GITHUB_REPOSITORY.split('/');
         return { owner, repository };
     }
-    const url = (0, bash_1.$) `git remote get-url origin`;
+    const url = (0, sh_1.$) `git remote get-url origin`;
     const regex = /^git@github\.com:(.+)\/(.+)\.git$/;
     const matches = url.match(regex);
     if (!matches)
@@ -33,8 +33,8 @@ exports.getRepo = getRepo;
 function getCommitsSinceLastTag(lastTag) {
     const format = '<commit><hash>%h</hash><message>%B</message></commit>';
     const rawLog = lastTag !== ''
-        ? (0, bash_1.$) `git log --pretty=format:"${format}" ${lastTag}..HEAD`
-        : (0, bash_1.$) `git log --pretty=format:"${format}"`;
+        ? (0, sh_1.$) `git log --pretty=format:"${format}" ${lastTag}..HEAD`
+        : (0, sh_1.$) `git log --pretty=format:"${format}"`;
     const commitsXml = rawLog.match(/<commit>.*?<\/commit>/gs);
     if (!commitsXml)
         return [];
@@ -46,7 +46,7 @@ function getCommitsSinceLastTag(lastTag) {
 }
 exports.getCommitsSinceLastTag = getCommitsSinceLastTag;
 function getCurrentBranch() {
-    return (0, bash_1.$) `git rev-parse --abbrev-ref HEAD`;
+    return (0, sh_1.$) `git rev-parse --abbrev-ref HEAD`;
 }
 exports.getCurrentBranch = getCurrentBranch;
 //# sourceMappingURL=git.js.map

package/dist/lib/npm.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.publishPackage = void 0;
-const bash_1 = require("./bash");
+const sh_1 = require("./sh");
 function publishPackage(channel) {
-    (0, bash_1.$) `npm publish --tag ${channel || 'latest'}`;
+    (0, sh_1.$) `npm publish --tag ${channel || 'latest'}`;
 }
 exports.publishPackage = publishPackage;
 //# sourceMappingURL=npm.js.map

package/dist/lib/{bash.js → sh.js}

@@ -23,4 +23,4 @@ function cmd(cmd) {
     (0, child_process_1.execSync)(cmd, { encoding: 'utf8', stdio: 'inherit' });
 }
 exports.cmd = cmd;
-//# sourceMappingURL=bash.js.map
+//# sourceMappingURL=sh.js.map

package/package.json

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