autorel 1.1.6 → 2.0.1

package/README.md

@@ -181,16 +181,16 @@ Whether to publish the release to NPM. If `true`, you must be authenticated with
 
 Whether to run in dry-run mode. This will not push the tag, create the release, publish to NPM, or run the command.
 
-- CLI: `--dry`
+- CLI: `--dry-run`
 - Argument: `dryRun: boolean`
 - Default: `false`
 
-## noRelease
+## skipRelease
 
 Whether to skip creating a release on GitHub. If `true`, the release will not be created, but the tag will still be pushed and the package on npm will still be updated, if applicable.
 
-- CLI: `--no-release`
-- Argument: `noRelease: boolean`
+- CLI: `--skip-release`
+- Argument: `skipRelease: boolean`
 - Default: `false`
 
 ## run
@@ -223,11 +223,11 @@ runScript: |
 - Argument: `runScript: string`
 - Default: `undefined`
 
-## pre-release
+## preRelease
 
-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, the "latest" tag will be used for NPM.
+> ❗️ This is typically set via the `branches` configuration (recommended), but can be overridden here.
 
-This is typically set via the `branches` configuration (recommended), but can be overridden here.
+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, the "latest" tag will be used for NPM.
 
 - CLI: `--pre-release`
 - Argument: `preRelease: string`
@@ -248,19 +248,19 @@ The commit types to use for both the release notes and version bumping. If not p
 
 ## branches (YAML only)
 
-The branches to use for the release along with their channel. If not provided, the default is:
+The branches to use for the release along with their pre-release channel. If not provided, the default is:
 
 ```yaml
 - {name: 'main'}
 ```
 
-The above will release to the `latest` channel on NPM. If you want to release to a different channel, you can specify it like so:
+The above will release to the `latest` channel on NPM. If you want to release to a different channel (making it a pre-release), you can specify it like so:
 
 ```yaml
 branches:
   - {name: 'main'}
-  - {name: 'develop', channel: 'alpha'}
-  - {name: 'staging', channel: 'beta'}
+  - {name: 'develop', prereleaseChannel: 'alpha'}
+  - {name: 'staging', prereleaseChannel: 'beta'}
 ```
 
 The above will release to the `latest` channel (production) on NPM for the `main` branch, the `alpha` pre-release channel for the `develop` branch, and the `beta` pre-release channel for the `staging` branch.
@@ -284,7 +284,7 @@ The version to use for the release INSTEAD of the version being generated. Alway
 # Define the branches and their respective channels
 branches:
   - {name: 'main'}
-  - {name: 'next', channel: 'next'}
+  - {name: 'next', prereleaseChannel: 'next'}
 
 # Enable publishing to NPM
 publish: true

package/dist/cli.js

@@ -17,23 +17,29 @@ console.log('----------------------------');
 program
     .version(packageJson.version, '-v, --version')
     .description('An example CLI for managing a directory')
-    .option('--dry', 'Do a dry run (arg: dryRun)')
+    .option('--dryRun', 'Do a dry run (arg: dryRun)')
     .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('--no-release', 'Skips creating a release on GitHub. (arg: noRelease)')
+    .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);
 const options = program.opts();
 const cliOptions = {
-    dryRun: options.dry,
+    dryRun: options.dryRun,
     run: options.run,
     prereleaseChannel: options.preRelease,
     useVersion: options.useVersion,
     publish: options.publish,
-    noRelease: options.release === false,
+    skipRelease: options.skipRelease,
 };
 const config = (0, config_1.getConfig)(cliOptions);
+// remove falsy values from the overrides
+if (config) {
+    Object.keys(config).forEach((key) => (
+    // @ts-ignore
+    !config[key] && delete config[key]));
+}
 output_1.default.debug(`CLI Options: ${JSON.stringify(cliOptions, null, 2)}`);
 output_1.default.debug(`Config: ${JSON.stringify(config, null, 2)}`);
 (0, _1.autorel)(config);

package/dist/config.js

@@ -39,7 +39,7 @@ const validateConfig = rtype_1.predicates.object({
     runScript: rtype_1.predicates.optional(rtype_1.predicates.string()),
     prereleaseChannel: rtype_1.predicates.optional(rtype_1.predicates.string()),
     useVersion: rtype_1.predicates.optional(rtype_1.predicates.string()),
-    noRelease: rtype_1.predicates.optional(rtype_1.predicates.boolean()),
+    skipRelease: rtype_1.predicates.optional(rtype_1.predicates.boolean()),
     publish: rtype_1.predicates.optional(rtype_1.predicates.boolean()),
     breakingChangeTitle: rtype_1.predicates.optional(rtype_1.predicates.string()),
     commitTypes: rtype_1.predicates.optional(rtype_1.predicates.array(rtype_1.predicates.object({

package/dist/index.d.ts

@@ -13,7 +13,7 @@ export type Config = {
     runScript?: string;
     prereleaseChannel?: string;
     useVersion?: string;
-    noRelease?: boolean;
+    skipRelease?: boolean;
     publish?: boolean;
     breakingChangeTitle: string;
     commitTypes: CommitType[];

package/dist/index.js

@@ -103,7 +103,7 @@ async function autorel(args) {
         return;
     git.createAndPushTag(nextTag);
     const { owner, repository } = git.getRepo();
-    !args.noRelease && github.createRelease({
+    !args.skipRelease && github.createRelease({
         token: process.env.GITHUB_TOKEN,
         owner,
         repository,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "1.1.6",
+  "version": "2.0.1",
   "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)",
@@ -28,7 +28,22 @@
     "build": "rm -rf ./dist && tsc"
   },
   "homepage": "https://github.com/mhweiner/autorel/blob/main/README.md",
-  "keywords": [],
+  "keywords": [
+    "semantic-release",
+    "semantic commits",
+    "conventional commits",
+    "semantic versioning",
+    "automatic release",
+    "automatic builds",
+    "builds",
+    "ci/cid",
+    "ci-cd",
+    "continuous integration",
+    "continuous deployment",
+    "automation",
+    "release automation",
+    "release-please"
+  ],
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^17.0.0",