autorel 2.2.6 → 2.2.8-next.3

package/README.md

@@ -35,10 +35,13 @@ _Currently only has built-in support for `GitHub` and `NPM`, but you can write y
 - Comprehensive test coverage
 - Less broken builds and more time to focus on your code!
 
+[Read our FAQ on why you should use `autorel` and how it compares to other tools](docs/faq.md)
+
 # Table of Contents
 
 - [Example Usage (CLI)](#example-usage-cli)
 - [Example Usage (Library)](#example-usage-library)
+- [System Requirements](#system-requirements)
 - [Commit Messages](#commit-messages)
 - [Usage with GitHub Actions](#usage-with-github-actions)
 - [Usage with Other Repositories (not GitHub)](#usage-with-other-repositories-not-github)
@@ -74,7 +77,9 @@ autorel --publish
 
 ## Avoiding Breaking Changes
 
-You may want to add the version number to the npx command to prevent breaking changes in the future. For example, `npx autorel@^2 --publish --run 'echo "Next version is ${NEXT_VERSION}"'`
+If using the `npx` command, you may want to append the version number to prevent breaking changes in the future. You can do this by appending `@^` followed by the major version number.
+
+Example: `npx autorel@^2`
 
 # Example Usage (Library)
 
@@ -94,6 +99,14 @@ You may want to add the version number to the npx command to prevent breaking ch
     });
     ```
 
+# System Requirements
+
+- Linux or MacOS (Windows is not officially supported)
+- Node.js 14+
+- NPM 7+
+- Git 2.13+
+- Bash
+
 # Commit Messages
 
 Commit messages are parsed to determine the version bump. They must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard specification.
@@ -135,15 +148,7 @@ jobs:
           node-version: latest
           registry-url: "https://registry.npmjs.org"
           cache: 'npm'
-      - uses: actions/cache@v3
-        id: cache-node-modules
-        with:
-          path: node_modules
-          key: ${{runner.os}}-node-${{hashFiles('package-lock.json')}}
-      - run: npm ci
-      - run: npm run lint
-      - run: npm run test
-      - run: npx autorel --publish
+      - run: npx autorel@^2
         env:
             GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
             NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
@@ -155,7 +160,7 @@ It's also recommended you create a `.autorel.yaml` file in the root of your proj
 
 `autorel` is designed to work with any CI/CD system, not just GitHub Actions. You can use it with GitLab, Bitbucket, Jenkins, or any other system that supports running shell commands.
 
-Simply use the `--skip-release` flag (arg: `skipRelease: true`) to skip creating a release on GitHub. Then, you can use either the `--run` flag (arg: `run: string`) or `runScript` arg to run any command or script after the version bump with the new version number available as an environment variable [see below](#run).
+Simply use the `--skip-release` flag (arg: `skipRelease: true`) to skip creating a release on GitHub. Then, you can use the `--run` flag (arg: `run: string`) to run any command or script after the version bump with the new version number available as an environment variable [see below](#run).
 
 If you're interested in contributing built-in support for other systems, please open an issue or PR.
 
@@ -173,9 +178,9 @@ When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml`
 
 However, omitting the `--publish` flag will still publish to NPM if `publish: true` is set in the `yaml` file, and the same for other binary flags.
 
-When used as a library, you can pass the configuration directly to the `autorel` function.
+When used as a library, you pass the configuration directly to the `autorel` function.
 
-All arguments are optional, but setting `branches` is recommended.
+All arguments are optional.
 
 > ❗️ The `yaml` configuration file must be named `.autorel.yaml` and be in the root of your project.
 
@@ -207,32 +212,59 @@ 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. The following environment variables are available:
+A `bash` command/script to run after the release is complete. All scripts are run in "-e" mode, meaning they will exit on the first error.
+
+The following environment variables are available:
 
 | Variable | Description |
 | --- | --- |
 | `NEXT_VERSION` | The new version number (without the `v`) |
 | `NEXT_TAG` | The new tag, ie. v3.1.0 |
 
+Example CLI usage:
+
+```bash
+npx autorel --run 'echo "Next version is ${NEXT_VERSION}"'
+```
+
+Example YAML usage:
+
+```yaml
+run: echo "Next version is ${NEXT_VERSION}"
+```
+
+You can use the multi-line string syntax in YAML to write a script:
+
+```yaml
+run: |
+  echo "$(date +"%Y-%m-%d") ${NEXT_VERSION}" >> versions.txt
+  aws s3 sync . s3://my-bucket
+```
+
 - CLI: `--run`
 - Argument: `run: string`
 - Default: `undefined`
 
-## runScript (YAML only)
+## preRun
 
-A bash script to run after the release is complete. The same environment variables are available as above.
+A `bash` command/script to run before the release is started. All scripts are run in "-e" mode, meaning they will exit on the first error. Here's where you can do things like run tests or do build steps.
 
-> ❗️ This requires `bash` to be installed on the system.
+This could save you time and money by not running unnecessary steps in your CI/CD pipeline. It will not run if no release is determined to be necessary, and it will not run in dry-run mode.
 
-You can use the multi-line string syntax in YAML to write a script:
+This is run *after* determining the new version number but *before* pushing tags, creating the release on GitHub, updating the package.json, or publishing to NPM. 
+
+Example YAML usage: 
 
 ```yaml
-runScript: |
-  echo 'Hello, World!' > hello.txt
-  echo 'Goodbye, World!' > goodbye.txt
+preRun: |
+  npm ci
+  npm run build
+  npm run test
+  npm run lint
 ```
 
-- Argument: `runScript: string`
+- CLI: `--pre-run`
+- Argument: `preRun: string`
 - Default: `undefined`
 
 ## preRelease
@@ -245,20 +277,21 @@ The pre-release channel to use. This will be appended to the version number. For
 - Argument: `preRelease: string`
 - Default: `undefined`
 
-## breakingChangeTitle (YAML only)
+## breakingChangeTitle (YAML/library only)
 
 The title to use for the breaking changes section in the release notes.
 
 - Argument: `breakingChangeTitle: string`
 - Default: `"🚨 Breaking Changes 🚨"`
 
-## commitTypes (YAML only)
+## commitTypes (YAML/library only)
 
-The commit types to use for both the release notes and version bumping. If not provided, the default commit types can be found in [src/defaults.ts](src/defaults.ts).
+The commit types to use for both the release notes and version bumping.
 
 - Argument: `commitTypes: CommitType[]`
+- Defaults: [src/defaults.ts](src/defaults.ts)
 
-## branches (YAML only)
+## branches (YAML/library only)
 
 The branches to use for the release along with their pre-release channel. If not provided, the default is:
 
@@ -302,7 +335,7 @@ branches:
 publish: true
 
 # Run custom script after publish
-runScript: |
+run: |
   echo "$(date +"%Y-%m-%d") ${NEXT_VERSION}" >> versions.txt
   aws s3 sync . s3://my-bucket
 ```
@@ -325,11 +358,12 @@ This will output configuration and other debug information.
 
 If using our npm publishing feature, the package.json file's version will be updated in memory before being pushed to npm, as this is the only place where it's actually required. The change will not be pushed to the repository, as it is not necessary and could cause conflicts. See [this post](https://semantic-release.gitbook.io/semantic-release/support/faq)
 
-# Support, Feedback, and Contributions
+If you need access to the new version number in your CI/CD pipeline, you can use the `NEXT_VERSION` or `NEXT_TAG` environment variables.
+
+# Support & Feedback
 
 - Star this repo if you like it!
 - Submit an [issue](https://github.com/mhweiner/autorel/issues) with your problem, feature request or bug report
-- Issue a PR against `main` and request review. Make sure all tests pass and coverage is good.
 - Write about `autorel` in your blog, tweet about it, or share it with your friends!
 - Support this package by adding our badge to your README:
 
@@ -337,18 +371,13 @@ If using our npm publishing feature, the package.json file's version will be upd
 [![autorel](https://raw.githubusercontent.com/mhweiner/autorel/main/badge.svg)](https://github.com/mhweiner/autorel)
 ```
 
+# Contributors & Maintainers Wanted!
+
+We are looking for contributors and maintainers to help with the project. If you are interested, please open an issue or PR. Together we can help bring automated releases to everyone!
+
 ## License
 
 MIT © Marc H. Weiner
 
 [See full license](LICENSE)
 
-## Sponsors
-
-<picture>
-    <source srcset="docs/aeroview-logo-lockup.svg" media="(prefers-color-scheme: dark)">
-    <source srcset="docs/aeroview-logo-lockup-dark.svg" media="(prefers-color-scheme: light)">
-    <img src="docs/aeroview-logo-lockup-dark.svg" alt="Logo" style="max-width: 150px;margin: 0 0 10px">
-</picture>
-
-Aeroview is a developer-friendly, AI-powered observability platform that helps you monitor, troubleshoot, and optimize your applications. Get started for free at [https://aeroview.io](https://aeroview.io).

package/dist/cli.d.ts

@@ -3,6 +3,7 @@ export type CliFlags = {
     preRelease?: string;
     useVersion?: string;
     run?: string;
+    preRun?: string;
     noRelease?: boolean;
     publish?: boolean;
 };

package/dist/cli.js

@@ -21,6 +21,7 @@ program
     .option('--pre-release <value>', 'Pre-release channel. If specified, the release will be marked as a pre-release. Overrides branches configuration. (arg: preRelease)')
     .option('--use-version <value>', 'Specify a version to be used instead of calculating it from commit analysis. Must be a valid SemVer version, with no \'v\'. Overrides --pre-release, commitType, and branches configuration. (arg: useVersion)')
     .option('--run <value>', 'Command to run after the release is successful. (arg: run)')
+    .option('--pre-run <value>', 'Command to run after the release is successful. (arg: preRun)')
     .option('--skip-release', 'Skips creating a release on GitHub. (arg: skipRelease)')
     .option('--publish', 'Publish the package to npm, requires passing --npm-token or NPM_TOKEN environment variable. (arg: publish)')
     .parse(process.argv);
@@ -28,6 +29,7 @@ const options = program.opts();
 const cliOptions = {
     dryRun: options.dryRun,
     run: options.run,
+    preRun: options.preRun,
     prereleaseChannel: options.preRelease,
     useVersion: options.useVersion,
     publish: options.publish,

package/dist/config.js

@@ -36,6 +36,7 @@ const defaults_1 = require("./defaults");
 const validateConfig = typura_1.predicates.object({
     dryRun: typura_1.predicates.optional(typura_1.predicates.boolean()),
     run: typura_1.predicates.optional(typura_1.predicates.string()),
+    preRun: typura_1.predicates.optional(typura_1.predicates.string()),
     runScript: typura_1.predicates.optional(typura_1.predicates.string()),
     prereleaseChannel: typura_1.predicates.optional(typura_1.predicates.string()),
     useVersion: typura_1.predicates.optional(typura_1.predicates.string()),

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export type ReleaseBranch = {
 export type Config = {
     dryRun?: boolean;
     run?: string;
+    preRun?: string;
     runScript?: string;
     prereleaseChannel?: string;
     useVersion?: string;

package/dist/index.js

@@ -103,6 +103,13 @@ async function autorel(args) {
     output_1.default.debug(`The changelog is:\n${changelog}`);
     if (args.dryRun)
         return;
+    if (args.preRun) {
+        output_1.default.log('Running pre-release bash script:');
+        output_1.default.log('----------------------------');
+        output_1.default.log(args.preRun);
+        output_1.default.log('----------------------------');
+        (0, sh_1.bash)(args.preRun);
+    }
     git.createAndPushTag(nextTag);
     const { owner, repository } = git.getRepo();
     !args.skipRelease && github.createRelease({
@@ -120,15 +127,20 @@ async function autorel(args) {
     }
     process.env.NEXT_VERSION = nextTag.replace('v', '');
     process.env.NEXT_TAG = nextTag;
-    // run post-release script
+    // run post-release bash script
     if (args.run) {
-        output_1.default.log('Running post-release command:');
+        output_1.default.log('Running post-release bash script/command:');
         output_1.default.log('----------------------------');
         output_1.default.log(args.run);
         output_1.default.log('----------------------------');
-        (0, sh_1.cmd)(args.run);
+        (0, sh_1.bash)(args.run);
     }
     else if (args.runScript) {
+        // TODO: delete this block in the next major version
+        output_1.default.warn('----------------------------');
+        output_1.default.warn('🚨 The "runScript" option is deprecated. Please use "run" instead. 🚨');
+        output_1.default.warn('🚨 The "runScript" option will be removed in the next major version. 🚨');
+        output_1.default.warn('----------------------------');
         output_1.default.log('Running post-release bash script:');
         output_1.default.log('');
         output_1.default.log('----------------------------');

package/dist/lib/sh.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Executes a bash program/command and returns the output. This is a tagged template
+ * literal function, so you can use it like this:
+ *
+ *   const output = $`echo "Hello, World!"`;
+ *
+ * Also, it logs the command/script to the console in debug mode.
+ */
 export declare function $(strings: TemplateStringsArray, ...values: any[]): string;
+/**
+ * Executes a bash program/command but does not return the output. Is not a tagged template
+ * literal function. You can use it like this:
+ *
+ * bash('echo "Hello, World!" > /dev/null');
+ */
 export declare function bash(cmd: string): void;
-export declare function cmd(cmd: string): void;

package/dist/lib/sh.js

@@ -3,24 +3,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cmd = exports.bash = exports.$ = void 0;
+exports.bash = exports.$ = void 0;
 const child_process_1 = require("child_process");
 const output_1 = __importDefault(require("./output"));
+/**
+ * Executes a bash program/command and returns the output. This is a tagged template
+ * literal function, so you can use it like this:
+ *
+ *   const output = $`echo "Hello, World!"`;
+ *
+ * Also, it logs the command/script to the console in debug mode.
+ */
 function $(strings, ...values) {
     const command = strings.reduce((acc, str, i) => acc + str + (values[i] || ''), '');
     output_1.default.debug(command);
-    const escapedCommand = command.replace(/(["$`\\])/g, '\\$1').replace(/\n/g, '\\n');
+    const escapedCommand = command.replace(/(["$`\\])/g, '\\$1');
     const output = (0, child_process_1.execSync)(`bash -c "${escapedCommand}"`, { encoding: 'utf8' });
     return output.trim();
 }
 exports.$ = $;
+/**
+ * Executes a bash program/command but does not return the output. Is not a tagged template
+ * literal function. You can use it like this:
+ *
+ * bash('echo "Hello, World!" > /dev/null');
+ */
 function bash(cmd) {
-    const escapedCommand = cmd.replace(/(["$`\\])/g, '\\$1').replace(/\n/g, '\\n');
+    const escapedCommand = cmd.replace(/(["$`\\])/g, '\\$1');
     (0, child_process_1.execSync)(`bash -c "${escapedCommand}"`, { encoding: 'utf8', stdio: 'inherit' });
 }
 exports.bash = bash;
-function cmd(cmd) {
-    (0, child_process_1.execSync)(cmd, { encoding: 'utf8', stdio: 'inherit' });
-}
-exports.cmd = cmd;
 //# sourceMappingURL=sh.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "2.2.6",
+  "version": "2.2.8-next.3",
   "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)",