autorel 0.0.21 → 0.0.23

package/README.md

@@ -23,7 +23,7 @@ Autorel automatically does the following, if appropriate:
 - Unlike some other tools, `autorel` is 100% compliant with Conventional Commits and SemVer out of the box, including "!" for breaking changes
 
 **😃 Simple & Easy to Use**
-- No confusing configuration files
+- No confusing configuration files or complex setup
 - Works with any CI/CD system, including GitHub Actions
 - Out of the box TypeScript support
 
@@ -35,7 +35,7 @@ Autorel automatically does the following, if appropriate:
 # Example Usage (CLI)
 
 ```bash
-npx autorel --publish --run "echo \"Next version is ${NEXT_VERSION}!\""
+npx autorel --publish --run 'echo "Next version is ${NEXT_VERSION}"'
 ```
 
 This will:
@@ -43,7 +43,7 @@ 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 "Next version is ${NEXT_VERSION}!"`
+4. Run the command `echo "Next version is ${NEXT_VERSION}"`
 
 You can also install `autorel` globally and run it that way:
 
@@ -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,20 +142,14 @@ 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.
+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.
 
-- CLI: `--pre`
-- Argument: `pre: string`
+- CLI: `--pre-release`
+- Argument: `preRelease: string`
 - Default: `undefined`
 
 ## breakingChangeTitle (YAML only)
@@ -192,6 +186,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>
@@ -215,7 +219,7 @@ You can find the types defined at [src/index.ts](src/index.ts).
 - 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!
 
-## Sponors
+## Sponsors
 
 <picture>
     <source srcset="docs/aeroview-logo-lockup.svg" media="(prefers-color-scheme: dark)">

package/dist/cli.d.ts

@@ -1 +1,8 @@
-export {};
+export type CliFlags = {
+    dry?: boolean;
+    preRelease?: string;
+    useVersion?: string;
+    run?: string;
+    noRelease?: boolean;
+    publish?: boolean;
+};

package/dist/cli.js

@@ -17,24 +17,24 @@ console.log('----------------------------');
 program
     .version(packageJson.version, '-v, --version')
     .description('An example CLI for managing a directory')
-    .option('--dry', 'Do a dry run')
-    .option('--pre-release <value>', 'Pre-release channel. If specified, the release will be marked as a pre-release. Overrides any other configuration.')
-    .option('--tag <value>', 'Specify a tag to be used instead of calculating it from commit analysis. Overrides --pre.')
-    .option('--run <value>', 'Command to run after the release is successful')
-    .option('--no-release', 'Does not create a release on GitHub (advanced use only)')
-    .option('--publish', 'Publish the package to npm, requires passing --npm-token or NPM_TOKEN environment variable')
+    .option('--dry', '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('--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 config = (0, config_1.getConfig)();
-output_1.default.debug(`Options: ${JSON.stringify(options, null, 2)}`);
-output_1.default.debug(`Config: ${JSON.stringify(config, null, 2)}`);
-(0, _1.autorel)({
-    ...config,
+const cliOptions = {
     dryRun: options.dry,
     run: options.run,
     prereleaseChannel: options.preRelease,
-    tag: options.tag,
+    useVersion: options.useVersion,
     publish: options.publish,
-    noRelease: options.noRelease,
-});
+    noRelease: options.release === false,
+};
+const config = (0, config_1.getConfig)(cliOptions);
+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);
 //# sourceMappingURL=cli.js.map

package/dist/config.d.ts

@@ -1,2 +1,2 @@
-import { Args } from '.';
-export declare function getConfig(): Args;
+import { Config } from '.';
+export declare function getConfig(overrides?: Partial<Config>): Config;

package/dist/config.js

@@ -38,7 +38,7 @@ const validateConfig = rtype_1.predicates.object({
     run: rtype_1.predicates.optional(rtype_1.predicates.string()),
     runScript: rtype_1.predicates.optional(rtype_1.predicates.string()),
     prereleaseChannel: rtype_1.predicates.optional(rtype_1.predicates.string()),
-    tag: 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()),
     publish: rtype_1.predicates.optional(rtype_1.predicates.boolean()),
     breakingChangeTitle: rtype_1.predicates.optional(rtype_1.predicates.string()),
@@ -64,6 +64,9 @@ function readAutorelYaml(filePath = '.autorel.yaml') {
         output_1.default.log('.autorel.yaml not found, using default configuration');
         return {};
     }
+    else {
+        output_1.default.log('Using .autorel.yaml configuration');
+    }
     const [readErr, fileContents] = (0, rtype_1.toResult)(() => fs.readFileSync(absolutePath, 'utf8'));
     if (readErr) {
         output_1.default.error('Error reading .autorel.yaml file:');
@@ -81,11 +84,12 @@ function readAutorelYaml(filePath = '.autorel.yaml') {
     }
     return parsedData;
 }
-function getConfig() {
+function getConfig(overrides) {
     const localConfig = readAutorelYaml();
     return {
         ...defaults_1.defaultConfig,
         ...localConfig,
+        ...overrides,
     };
 }
 exports.getConfig = getConfig;

package/dist/defaults.d.ts

@@ -1,2 +1,2 @@
-import { Args } from '.';
-export declare const defaultConfig: Args;
+import { Config } from '.';
+export declare const defaultConfig: Config;

package/dist/index.d.ts

@@ -7,17 +7,17 @@ export type ReleaseBranch = {
     name: string;
     prereleaseChannel?: string;
 };
-export type Args = {
+export type Config = {
     dryRun?: boolean;
     run?: string;
     runScript?: string;
     prereleaseChannel?: string;
-    tag?: string;
+    useVersion?: string;
     noRelease?: boolean;
     publish?: boolean;
     breakingChangeTitle: string;
     commitTypes: CommitType[];
     branches: ReleaseBranch[];
 };
-export declare function getPrereleaseChannel(args: Args): string | undefined;
-export declare function autorel(args: Args): Promise<void>;
+export declare function getPrereleaseChannel(config: Config): string | undefined;
+export declare function autorel(args: Config): Promise<void>;

package/dist/index.js

@@ -36,16 +36,14 @@ const color = __importStar(require("./lib/colors"));
 const changelog_1 = require("./changelog");
 const github = __importStar(require("./services/github"));
 const output_1 = __importDefault(require("./lib/output"));
-const config_1 = require("./config");
 const versionBump_1 = require("./versionBump");
 const sh_1 = require("./lib/sh");
-function getPrereleaseChannel(args) {
-    if (args.prereleaseChannel)
-        return args.prereleaseChannel;
+function getPrereleaseChannel(config) {
+    if (config.prereleaseChannel)
+        return config.prereleaseChannel;
     const branch = git.getCurrentBranch();
     if (!branch)
         throw new Error('Could not get the current branch.');
-    const config = (0, config_1.getConfig)();
     if (!config.branches || !config.branches.length)
         throw new Error('Branches are not defined in the configuration.');
     const matchingBranch = config.branches.find((b) => b.name === branch);
@@ -59,7 +57,7 @@ async function autorel(args) {
     if (args.dryRun) {
         output_1.default.warn('Running in dry-run mode. No changes will be made.');
     }
-    if (prereleaseChannel && !args.tag) {
+    if (prereleaseChannel && !args.useVersion) {
         output_1.default.log(`Using prerelease channel: ${color.bold(prereleaseChannel)}`);
     }
     const commitTypeMap = new Map(args.commitTypes.map((type) => [type.type, type]));
@@ -77,29 +75,39 @@ async function autorel(args) {
         || (releaseType === 'minor' && color.yellow('minor'))
         || (releaseType === 'patch' && color.green('patch'));
     output_1.default.log(`The release type is: ${releaseTypeStr}`);
-    if (releaseType === 'none' && !args.tag) {
-        output_1.default.log('No release is needed. Have a nice day ^_^');
+    if (releaseType === 'none' && !args.useVersion) {
+        output_1.default.log('No release is needed. Have a nice day (^_^)/');
         return;
     }
-    const nextTag = semver.incrementVersion(lastProdTag || 'v0.0.1', lastTag || 'v0.0.1', releaseType, prereleaseChannel);
-    if (args.tag) {
-        output_1.default.log(`The next version would be ${nextTag}, but the tag was set by --tag to be ${color.bold(args.tag)}.`);
-        output_1.default.warn('The tag was overriden by the --tag parameter. This may cause the next release to be incorrect. Make sure you know what you are doing. This may fail if the tag already exists.');
+    const nextTagCalculated = semver.incrementVersion(lastProdTag || 'v0.0.1', lastTag || 'v0.0.1', releaseType, prereleaseChannel);
+    if (args.useVersion) {
+        if (/^v(.+)$/.test(args.useVersion))
+            throw new Error('useVersion should not start with a "v".');
+        if (!semver.isValidVersion(args.useVersion))
+            throw new Error('useVersion must be a valid SemVer version');
+        if (releaseType === 'none') {
+            output_1.default.warn(`We didn't find any commmits that would create a release, but you have set 'useVersion', which will force a release as: ${color.bold(args.useVersion)}.`);
+        }
+        else {
+            output_1.default.warn(`The next version would be ${nextTagCalculated}, but the version was set by useVersion to be: ${color.bold(args.useVersion)}.`);
+        }
+        output_1.default.warn('I hope you know what you\'re doing. (=^･ω･^=)');
     }
     else {
-        output_1.default.log(`The next version is: ${color.bold(nextTag)}`);
+        output_1.default.log(`The next version is: ${color.bold(nextTagCalculated)}`);
     }
+    const nextTag = args.useVersion ? `v${args.useVersion}` : nextTagCalculated;
     const changelog = (0, changelog_1.generateChangelog)(parsedCommits, commitTypeMap, args.breakingChangeTitle);
     output_1.default.debug(`The changelog is:\n${changelog}`);
     if (args.dryRun)
         return;
-    git.createAndPushTag(args.tag ? args.tag : nextTag);
+    git.createAndPushTag(nextTag);
     const { owner, repository } = git.getRepo();
     !args.noRelease && github.createRelease({
         token: process.env.GITHUB_TOKEN,
         owner,
         repository,
-        tag: args.tag ? args.tag : nextTag,
+        tag: nextTag,
         name: nextTag,
         body: changelog,
     });
@@ -112,11 +120,9 @@ async function autorel(args) {
     // run post-release script
     if (args.run) {
         output_1.default.log('Running post-release command:');
-        output_1.default.log('');
         output_1.default.log('----------------------------');
         output_1.default.log(args.run);
         output_1.default.log('----------------------------');
-        output_1.default.log('');
         (0, sh_1.cmd)(args.run);
     }
     else if (args.runScript) {

package/dist/semver.d.ts

@@ -13,4 +13,5 @@ export declare function incrPatch(version: Semver): Semver;
 export declare function incrMinor(version: Semver): Semver;
 export declare function incrMajor(version: Semver): Semver;
 export declare function returnHighestVersion(version1: Semver, version2: Semver): Semver;
+export declare function isValidVersion(ver: string): boolean;
 export {};

package/dist/semver.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnHighestVersion = exports.incrMajor = exports.incrMinor = exports.incrPatch = exports.incrByType = exports.incrementVersion = exports.fromTag = exports.toTag = void 0;
+exports.isValidVersion = exports.returnHighestVersion = exports.incrMajor = exports.incrMinor = exports.incrPatch = exports.incrByType = exports.incrementVersion = exports.fromTag = exports.toTag = void 0;
 function toTag(version) {
     let versionString = `${version.major}.${version.minor}.${version.patch}`;
     if (version.channel) {
@@ -226,4 +226,8 @@ function returnHighestVersion(version1, version2) {
     return version1;
 }
 exports.returnHighestVersion = returnHighestVersion;
+function isValidVersion(ver) {
+    return !!fromTag(`v${ver}`);
+}
+exports.isValidVersion = isValidVersion;
 //# sourceMappingURL=semver.js.map

package/package.json

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