release-it 17.3.0 → 17.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 🚀 Generic CLI tool to automate versioning and package publishing-related tasks:
 
-<img align="right" src="./docs/assets/release-it.svg?raw=true" height="280">
+<img align="right" src="./docs/assets/release-it.svg?raw=true" height="280" />
 
 - Bump version (in e.g. `package.json`)
 - [Git commit, tag, push][1]
@@ -113,7 +113,7 @@ Here's a quick example `.release-it.json`:
 
 By default, release-it is **interactive** and allows you to confirm each task before execution:
 
-<img src="./docs/assets/release-it-interactive.gif?raw=true" height="290">
+<img src="./docs/assets/release-it-interactive.gif?raw=true" height="290" />
 
 By using the `--ci` option, the process is fully automated without prompts. The configured tasks will be executed as
 demonstrated in the first animation above. In a Continuous Integration (CI) environment, this non-interactive mode is
@@ -316,42 +316,43 @@ Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab
 While mostly used as a CLI tool, release-it can be used as a dependency to integrate in your own scripts. See [use
 release-it programmatically][52] for example code.
 
-## Example projects using release-it
-
-- [axios/axios][53]
-- [blockchain/blockchain-wallet-v4-frontend][54]
-- [callstack/react-native-paper][55]
-- [ember-cli/ember-cli][56]
-- [js-cookie/js-cookie][57]
-- [metalsmith/metalsmith][58]
-- [mozilla/readability][59]
-- [pahen/madge][60]
-- [redis/node-redis][61]
-- [reduxjs/redux][62]
-- [saleor/saleor][63]
-- [Semantic-Org/Semantic-UI-React][64]
-- [shipshapecode/shepherd][65]
-- [StevenBlack/hosts][66]
-- [swagger-api/swagger-ui][67] + [swagger-editor][68]
-- [tabler/tabler][69] + [tabler-icons][70]
-- [youzan/vant][71]
-- [Repositories that depend on release-it][72]
-- GitHub search for [path:\*\*/.release-it.json][73]
+## Projects using release-it
+
+- [AdonisJs][53]
+- [Axios][54]
+- [Cal.com][55]
+- [Ember CLI][56]
+- [Halo][57]
+- [hosts][58]
+- [js-cookie][59]
+- [Madge][60]
+- [Metalsmith][61]
+- [Node-Redis][62]
+- [React Native Paper][63]
+- [Readability.js][64]
+- [Redux][65]
+- [Saleor][66]
+- [Semantic UI React][67]
+- [Shepherd][68]
+- [Tabler][69] + [tabler-icons][70]
+- Swagger ([swagger-ui][71] + [swagger-editor][72])
+- [Repositories that depend on release-it][73]
+- GitHub search for [path:\*\*/.release-it.json][74]
 
 ## Legacy Node.js
 
 The latest major version is v17, supporting Node.js 18 and up (as Node.js v16 is EOL). The previous major version was
-v16, supporting Node.js 16. Use release-it v15 for environments running Node.js v14. Also see [CHANGELOG.md][74].
+v16, supporting Node.js 16. Use release-it v15 for environments running Node.js v14. Also see [CHANGELOG.md][75].
 
 ## Links
 
-- See [CHANGELOG.md][74] for major/breaking updates, and [releases][75] for a detailed version history.
-- To **contribute**, please read [CONTRIBUTING.md][76] first.
-- Please [open an issue][77] if anything is missing or unclear in this documentation.
+- See [CHANGELOG.md][75] for major/breaking updates, and [releases][76] for a detailed version history.
+- To **contribute**, please read [CONTRIBUTING.md][77] first.
+- Please [open an issue][78] if anything is missing or unclear in this documentation.
 
 ## License
 
-[MIT][78]
+[MIT][79]
 
 Are you using release-it at work? Please consider [sponsoring me][14]!
 
@@ -407,29 +408,30 @@ Are you using release-it at work? Please consider [sponsoring me][14]!
 [50]: https://www.npmjs.com/search?q=keywords:release-it-plugin
 [51]: ./docs/plugins.md
 [52]: ./docs/recipes/programmatic.md
-[53]: https://github.com/axios/axios
-[54]: https://github.com/blockchain/blockchain-wallet-v4-frontend
-[55]: https://github.com/callstack/react-native-paper
+[53]: https://github.com/adonisjs/core
+[54]: https://github.com/axios/axios
+[55]: https://github.com/calcom/cal.com
 [56]: https://github.com/ember-cli/ember-cli
-[57]: https://github.com/js-cookie/js-cookie
-[58]: https://github.com/metalsmith/metalsmith
-[59]: https://github.com/mozilla/readability
+[57]: https://github.com/halo-dev/halo
+[58]: https://github.com/StevenBlack/hosts
+[59]: https://github.com/js-cookie/js-cookie
 [60]: https://github.com/pahen/madge
-[61]: https://github.com/redis/node-redis
-[62]: https://github.com/reduxjs/redux
-[63]: https://github.com/saleor/saleor
-[64]: https://github.com/Semantic-Org/Semantic-UI-React
-[65]: https://github.com/shipshapecode/shepherd
-[66]: https://github.com/StevenBlack/hosts
-[67]: https://github.com/swagger-api/swagger-ui
-[68]: https://github.com/swagger-api/swagger-editor
+[61]: https://github.com/metalsmith/metalsmith
+[62]: https://github.com/redis/node-redis
+[63]: https://github.com/callstack/react-native-paper
+[64]: https://github.com/mozilla/readability
+[65]: https://github.com/reduxjs/redux
+[66]: https://github.com/saleor/saleor
+[67]: https://github.com/Semantic-Org/Semantic-UI-React
+[68]: https://github.com/shipshapecode/shepherd
 [69]: https://github.com/tabler/tabler
 [70]: https://github.com/tabler/tabler-icons
-[71]: https://github.com/youzan/vant
-[72]: https://github.com/release-it/release-it/network/dependents
-[73]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
-[74]: ./CHANGELOG.md
-[75]: https://github.com/release-it/release-it/releases
-[76]: ./.github/CONTRIBUTING.md
-[77]: https://github.com/release-it/release-it/issues/new
-[78]: ./LICENSE
+[71]: https://github.com/swagger-api/swagger-ui
+[72]: https://github.com/swagger-api/swagger-editor
+[73]: https://github.com/release-it/release-it/network/dependents
+[74]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
+[75]: ./CHANGELOG.md
+[76]: https://github.com/release-it/release-it/releases
+[77]: ./.github/CONTRIBUTING.md
+[78]: https://github.com/release-it/release-it/issues/new
+[79]: ./LICENSE

package/lib/config.js

@@ -12,6 +12,7 @@ const searchPlaces = [
   'package.json',
   '.release-it.json',
   '.release-it.js',
+  '.release-it.ts',
   '.release-it.cjs',
   '.release-it.yaml',
   '.release-it.yml',

package/lib/log.js

@@ -17,11 +17,11 @@ class Logger {
   }
 
   log(...args) {
-    console.log(...args); // eslint-disable-line no-console
+    console.log(...args);
   }
 
   error(...args) {
-    console.error(chalk.red('ERROR'), ...args); // eslint-disable-line no-console
+    console.error(chalk.red('ERROR'), ...args);
   }
 
   info(...args) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "17.3.0",
+  "version": "17.4.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -55,12 +55,14 @@
     "bin",
     "config",
     "lib",
-    "test"
+    "test",
+    "schema"
   ],
+  "types": "./types/index.d.ts",
   "scripts": {
     "knip": "knip",
     "lint": "eslint lib test",
-    "format": "prettier --write \"{lib,test}/**/*.js\"",
+    "format": "prettier --write eslint.config.mjs \"{lib,test}/**/*.js\"",
     "docs": "remark README.md 'docs/**/*.md' '.github/*.md' -o",
     "test": "ava --no-worker-threads && installed-check",
     "release": "./bin/release-it.js"
@@ -80,9 +82,9 @@
     "git-url-parse": "14.0.0",
     "globby": "14.0.1",
     "got": "13.0.0",
-    "inquirer": "9.2.22",
+    "inquirer": "9.2.23",
     "is-ci": "3.0.1",
-    "issue-parser": "7.0.0",
+    "issue-parser": "7.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
@@ -100,27 +102,31 @@
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
+    "@eslint/compat": "1.1.0",
+    "@eslint/eslintrc": "3.1.0",
+    "@eslint/js": "9.5.0",
     "@octokit/request-error": "5.1.0",
     "ava": "6.1.3",
-    "eslint": "8.57.0",
+    "eslint": "9.5.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-ava": "14.0.0",
+    "eslint-plugin-ava": "15.0.1",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-prettier": "5.1.3",
     "fs-monkey": "1.0.6",
+    "globals": "15.6.0",
     "installed-check": "9.3.0",
-    "knip": "5.16.0",
-    "memfs": "4.9.2",
+    "knip": "5.22.1",
+    "memfs": "4.9.3",
     "mock-stdio": "1.0.3",
     "nock": "13.5.4",
-    "prettier": "3.2.5",
+    "prettier": "3.3.2",
     "remark-cli": "12.0.1",
     "remark-preset-webpro": "1.1.0",
     "sinon": "18.0.0",
     "strip-ansi": "7.1.0"
   },
   "engines": {
-    "node": "^18.18.0 || ^20.8.0 || ^22.0.0"
+    "node": "^18.18.0 || ^20.9.0 || ^22.0.0"
   },
   "remarkConfig": {
     "plugins": [

package/schema/git.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "release-it#git",
+  "title": "JSON schema for release-it Git configuration",
+  "type": "object",
+  "additionalItems": false,
+  "properties": {
+    "changelog": {
+      "type": "string",
+      "default": "git log --pretty=format:\"* %s (%h)\" ${from}...${to}"
+    },
+    "requireCleanWorkingDir": {
+      "type": "boolean",
+      "default": true
+    },
+    "requireBranch": {
+      "type": "boolean",
+      "default": false
+    },
+    "requireUpstream": {
+      "type": "boolean",
+      "default": true
+    },
+    "requireCommits": {
+      "type": "boolean",
+      "default": false
+    },
+    "requireCommitsFail": {
+      "type": "boolean",
+      "default": true
+    },
+    "commitsPath": {
+      "type": "string",
+      "default": ""
+    },
+    "addUntrackedFiles": {
+      "type": "string",
+      "default": ""
+    },
+    "commit": {
+      "type": "boolean",
+      "default": true
+    },
+    "commitArgs": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "tag": {
+      "type": "boolean",
+      "default": true
+    },
+    "tagExclude": {
+      "type": "string",
+      "default": null
+    },
+    "tagMatch": {
+      "type": "string",
+      "default": null
+    },
+    "getLatestTagFromAllRefs": {
+      "type": "boolean",
+      "default": false
+    },
+    "tagAnnotation": {
+      "type": "string",
+      "default": "Release ${version}"
+    },
+    "tagArgs": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "push": {
+      "type": "boolean",
+      "default": true
+    },
+    "pushArgs": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      },
+      "default": ["--follow-tags"]
+    },
+    "pushRepo": {
+      "type": "string",
+      "default": ""
+    }
+  }
+}

package/schema/github.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "release-it#github",
+  "title": "JSON schema for release-it github configuration",
+  "type": "object",
+  "additionalItems": false,
+  "properties": {
+    "release": {
+      "type": "boolean",
+      "default": false
+    },
+    "releaseName": {
+      "type": "string",
+      "default": "Release ${version}"
+    },
+    "releaseNotes": {
+      "default": null
+    },
+    "autoGenerate": {
+      "type": "boolean",
+      "default": false
+    },
+    "preRelease": {
+      "type": "boolean",
+      "default": false
+    },
+    "draft": {
+      "type": "boolean",
+      "default": false
+    },
+    "tokenRef": {
+      "type": "string",
+      "default": "GITHUB_TOKEN"
+    },
+    "assets": {
+      "default": null
+    },
+    "host": {
+      "type": "string",
+      "default": null
+    },
+    "timeout": {
+      "type": "integer",
+      "default": 0
+    },
+    "proxy": {
+      "type": "string",
+      "default": null
+    },
+    "skipChecks": {
+      "type": "boolean",
+      "default": false
+    },
+    "web": {
+      "type": "boolean",
+      "default": false
+    },
+    "comments": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "submit": {
+          "type": "boolean",
+          "default": false
+        },
+        "issue": {
+          "type": "string",
+          "default": ":rocket: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"
+        },
+        "pr": {
+          "type": "string",
+          "default": ":rocket: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"
+        }
+      }
+    }
+  }
+}

package/schema/gitlab.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "release-it#gitlab",
+  "title": "JSON schema for release-it gitlab configuration",
+  "type": "object",
+  "additionalItems": false,
+  "properties": {
+    "release": {
+      "type": "boolean",
+      "default": false
+    },
+    "releaseName": {
+      "type": "string",
+      "default": "Release ${version}"
+    },
+    "releaseNotes": {
+      "default": null
+    },
+    "autoGenerate": {
+      "type": "boolean",
+      "default": false
+    },
+    "preRelease": {
+      "type": "boolean",
+      "default": false
+    },
+    "draft": {
+      "type": "boolean",
+      "default": false
+    },
+    "milesstones": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "tokenRef": {
+      "type": "string",
+      "default": "GITLAB_TOKEN"
+    },
+    "tokenHeader": {
+      "type": "string",
+      "default": "Private-Token"
+    },
+    "certificateAuthorityFile": {
+      "default": null
+    },
+    "assets": {
+      "default": null
+    },
+    "origin": {
+      "type": "string",
+      "default": null
+    },
+    "skipChecks": {
+      "type": "boolean",
+      "default": false
+    }
+  }
+}

package/schema/npm.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "release-it#npm",
+  "title": "JSON schema for release-it npm configuration",
+  "type": "object",
+  "additionalItems": false,
+  "properties": {
+    "publish": {
+      "type": "boolean",
+      "default": true
+    },
+    "publishPath": {
+      "type": "string",
+      "default": "."
+    },
+    "publishArgs": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "tag": {
+      "type": "string",
+      "default": null
+    },
+    "otp": {
+      "type": "string",
+      "default": null
+    },
+    "ignoreVersion": {
+      "type": "boolean",
+      "default": false
+    },
+    "allowSameVersion": {
+      "type": "boolean",
+      "default": false
+    },
+    "versionArgs": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "skipChecks": {
+      "type": "boolean",
+      "default": false
+    },
+    "timeout": {
+      "type": "integer",
+      "default": 10
+    }
+  }
+}

package/schema/release-it.json

@@ -0,0 +1,89 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "release-it#release-it",
+  "title": "JSON schema for release-it configuration",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "The JSON schema version used to validate this configuration file"
+    },
+    "hooks": {
+      "type": "object",
+      "additionalProperties": true,
+      "patternProperties": {
+        "^(before|after):((version|git|npm|github|gitlab):)?(init|bump|release)$": {
+          "if": {
+            "type": "array"
+          },
+          "then": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "else": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "plugins": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "git": {
+      "$comment": "Boolean or git config object",
+      "if": {
+        "type": "object"
+      },
+      "then": {
+        "$ref": "./git.json"
+      },
+      "else": {
+        "type": "boolean",
+        "default": false
+      }
+    },
+    "npm": {
+      "$comment": "Boolean or npm config object",
+      "if": {
+        "type": "object"
+      },
+      "then": {
+        "$ref": "./npm.json"
+      },
+      "else": {
+        "type": "boolean",
+        "default": false
+      }
+    },
+    "github": {
+      "$comment": "Boolean or github config object",
+      "if": {
+        "type": "object"
+      },
+      "then": {
+        "$ref": "./github.json"
+      },
+      "else": {
+        "type": "boolean",
+        "default": false
+      }
+    },
+    "gitlab": {
+      "$comment": "Boolean or gitlab config object",
+      "if": {
+        "type": "object"
+      },
+      "then": {
+        "$ref": "./gitlab.json"
+      },
+      "else": {
+        "type": "boolean",
+        "default": false
+      }
+    }
+  }
+}

package/test/github.js

@@ -23,7 +23,7 @@ test.serial('should check token and perform checks', async t => {
   const options = { github: { release: true, tokenRef, pushRepo } };
   const github = factory(GitHub, { options });
 
-  process.env[tokenRef] = '123'; // eslint-disable-line require-atomic-updates
+  process.env[tokenRef] = '123';
 
   interceptAuthentication();
   interceptCollaborator();

package/test/gitlab.js

@@ -24,7 +24,7 @@ test.serial('should validate token', async t => {
   await t.throwsAsync(gitlab.init(), {
     message: /^Environment variable "MY_GITLAB_TOKEN" is required for GitLab releases/
   });
-  process.env[tokenRef] = '123'; // eslint-disable-line require-atomic-updates
+  process.env[tokenRef] = '123';
 
   interceptUser(undefined, { reqheaders: { 'private-token': '123' } });
   interceptCollaborator(undefined, { reqheaders: { 'private-token': '123' } });