autorel 1.1.1 → 1.1.3

package/README.md

@@ -17,12 +17,15 @@ Autorel automatically does the following, if appropriate:
 - Publishes the package to NPM
 - Runs any arbitrary command or bash script
 
+_Currently only comes with built-in support for `GitHub` and `NPM`, but you can write your own scripts to support other systems._
+
 **✅ Conventional Commit and SemVer Compliant**
 - 100% compliant with Conventional Commits and SemVer out of the box, including "!" for breaking changes
 
 **😃 Simple & Easy to Use**
 - No confusing configuration files or complex setup
 - Works with any CI/CD system, including GitHub Actions
+- Works with any language or platform
 - Built-in bash script support
 
 **🚀 Fast & Lightweight**
@@ -34,9 +37,9 @@ Autorel automatically does the following, if appropriate:
 
 - [Example Usage (CLI)](#example-usage-cli)
 - [Example Usage (Library)](#example-usage-library)
-- [Quick Start](#quick-start)
 - [Usage with GitHub Actions](#usage-with-github-actions)
 - [Example Commit Messages](#example-commit-messages)
+- [Usage with Anything Other Than GitHub](#usage-with-anything-other-than-github)
 - [Configuration](#configuration)
 - [Sample YAML Configuration](#sample-yaml-configuration)
 - [Types](#types)
@@ -52,9 +55,9 @@ npx autorel --publish --run 'echo "Next version is ${NEXT_VERSION}"'
 
 This will:
 
-1. Bump the version based on the commit messages since the last release (including pushing the tag and updating package.json)
+1. Bump the version based on the commit messages since the last release
 2. Create a new release on GitHub with Release Notes
-3. Publish the release to NPM
+3. Update package.json and publish the release to NPM (does not commit the change to the repository, see below)
 4. Run the command `echo "Next version is ${NEXT_VERSION}"`
 
 You can also install `autorel` globally and run it directly:
@@ -83,27 +86,6 @@ autorel --publish
 
     console.log(`Next version is ${nextVersion}`);
     ```
-# Quick Start
-
-There are many ways to use `autorel`. Here are a few common scenarios:
-
-1. **CLI**: Run `autorel` directly from the command line
-2. **Library**: Import `autorel` into your project and use it as a library
-3. **CI/CD pipeline**: Use `autorel` with GitHub Actions, CircleCI, Jenkins, etc. to automate your releases
-
-You can also use `autorel` with other languages, not just Node.js. Just make sure you have Node.js installed on the system.
-
-If you want to use GitHub Actions to automate your releases, [see here](#usage-with-github-actions) for setup and sample configuration.
-
-It's also recommended you create a `.autorel.yaml` file in the root of your project to [configure](#configuration) `autorel`. Example:
-
-```yaml
-branches:
-  - {name: 'main'}
-  - {name: 'alpha', channel: 'alpha'}
-  - {name: 'beta', channel: 'beta'}
-publish: true
-```
 
 # Usage with GitHub Actions
 
@@ -150,7 +132,9 @@ jobs:
 
 It's also recommended you create a `.autorel.yaml` file in the root of your project to [configure](#configuration) `autorel`.
 
-# Example Commit Messages
+# 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/) specification for automatic version bumping according to semantic versioning.
 
 Here are some examples of commit messages and the resulting version bump (default configuration):
 
@@ -160,6 +144,12 @@ Here are some examples of commit messages and the resulting version bump (defaul
 
 You can find more examples in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) documentation.
 
+# Usage with Anything Other Than GitHub
+
+`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 `--no-release` flag (arg: `noRelease: boolean`) 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 release is complete.
+
 # Configuration
 
 When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.

package/dist/index.js

@@ -36,7 +36,7 @@ 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 versionBump_1 = require("./versionBump");
+const updatePackageJsonVersion_1 = require("./updatePackageJsonVersion");
 const sh_1 = require("./lib/sh");
 function getPrereleaseChannel(config) {
     if (config.prereleaseChannel)
@@ -111,10 +111,11 @@ async function autorel(args) {
         name: nextTag,
         body: changelog,
     });
-    // update package.json
-    (0, versionBump_1.versionBump)(nextTag);
-    // publish package
-    args.publish && npm.publishPackage(prereleaseChannel);
+    // publish to npm
+    if (args.publish) {
+        (0, updatePackageJsonVersion_1.updatePackageJsonVersion)(nextTag);
+        npm.publishPackage(prereleaseChannel);
+    }
     process.env.NEXT_VERSION = nextTag.replace('v', '');
     process.env.NEXT_TAG = nextTag;
     // run post-release script

package/dist/updatePackageJsonVersion.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Bump the version of the package.json file
+ */
+export declare function updatePackageJsonVersion(newVersion: string): void;

package/dist/{versionBump.js → updatePackageJsonVersion.js}

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.versionBump = void 0;
+exports.updatePackageJsonVersion = void 0;
 const output_1 = __importDefault(require("./lib/output"));
 const fs_1 = require("fs");
 const fs = __importStar(require("fs"));
@@ -45,7 +45,7 @@ function readPackageJson() {
 /**
  * Bump the version of the package.json file
  */
-function versionBump(newVersion) {
+function updatePackageJsonVersion(newVersion) {
     const packageJson = readPackageJson();
     (0, fs_1.writeFileSync)('./package.json', JSON.stringify({
         ...packageJson,
@@ -53,5 +53,5 @@ function versionBump(newVersion) {
     }, null, 2));
     output_1.default.log('Successfully updated package.json locally');
 }
-exports.versionBump = versionBump;
-//# sourceMappingURL=versionBump.js.map
+exports.updatePackageJsonVersion = updatePackageJsonVersion;
+//# sourceMappingURL=updatePackageJsonVersion.js.map

package/package.json

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

package/dist/versionBump.d.ts

@@ -1,4 +0,0 @@
-/**
- * Bump the version of the package.json file
- */
-export declare function versionBump(newVersion: string): void;