release-it 14.14.0 → 14.14.3

package/README.md

@@ -156,7 +156,8 @@ remote.
 ## GitHub Releases
 
 GitHub projects can have releases attached to Git tags, containing release notes and assets. There are two ways to add
-[GitHub releases](https://help.github.com/articles/creating-releases) in your release-it flow:
+[GitHub releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) in your
+release-it flow:
 
 1. Automated (requires a `GITHUB_TOKEN`)
 2. Manual (using the GitHub web interface with pre-populated fields)
@@ -255,7 +256,7 @@ will run one after another. Some example release-it configuration:
 The variables can be found in the [default configuration](./config/release-it.json). Additionally, the following
 variables are exposed:
 
-```
+```text
 version
 latestVersion
 changelog
@@ -271,6 +272,14 @@ Use `--verbose` to log the output of the commands.
 For the sake of verbosity, the full list of hooks is actually: `init`, `beforeBump`, `bump`, `beforeRelease`, `release`
 or `afterRelease`. However, hooks like `before:beforeRelease` look weird and are usually not useful in practice.
 
+Note that arguments need to be quoted properly when used from the command line:
+
+```bash
+release-it --'hooks.after:release="echo Successfully released ${name} v${version} to ${repo.repository}."'
+```
+
+Using Inquirer.js inside custom hook scripts might cause issues (since release-it also uses this itself).
+
 ## Plugins
 
 Since v11, release-it can be extended in many, many ways. Here are some plugins:
@@ -319,29 +328,22 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [antonmedv/fx](https://github.com/antonmedv/fx)
 - [blockchain/blockchain-wallet-v4-frontend](https://github.com/blockchain/blockchain-wallet-v4-frontend)
 - [callstack/linaria](https://github.com/callstack/linaria)
+- [callstack/react-native-paper](https://github.com/callstack/react-native-paper)
 - [ember-cli/ember-cli](https://github.com/ember-cli/ember-cli)
-- [metalsmith/metalsmith](https://github.com/metalsmith/metalsmith)
-- [react-native-paper](https://github.com/callstack/react-native-paper)
 - [js-cookie/js-cookie](https://github.com/js-cookie/js-cookie)
-- [saleor/saleor](https://github.com/saleor/saleor)
+- [metalsmith/metalsmith](https://github.com/metalsmith/metalsmith)
 - [mozilla/readability](https://github.com/mozilla/readability)
 - [redis/node-redis](https://github.com/redis/node-redis)
+- [saleor/saleor](https://github.com/saleor/saleor)
 - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)
+- [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
 - [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) +
   [swagger-editor](https://github.com/swagger-api/swagger-editor)
-- [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
 - [tabler/tabler](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
 - [youzan/vant](https://github.com/youzan/vant)
 - [Repositories that depend on release-it](https://github.com/release-it/release-it/network/dependents)
 - GitHub search for [filename:.release-it.json](https://github.com/search?q=filename%3A.release-it.json)
 
-## Resources
+## License
 
-- [semver.org](https://semver.org)
-- [GitHub Help](https://docs.github.com) (→
-  [About Releases](https://docs.github.com/free-pro-team@latest/github/administering-a-repository/about-releases))
-- [npm Blog: Publishing what you mean to publish](https://blog.npmjs.org/post/165769683050/publishing-what-you-mean-to-publish)
-- [npm Documentation: package.json](https://docs.npmjs.com/cli/v6/configuring-npm/package-json)
-- [Prereleases and npm](https://medium.com/@mbostock/prereleases-and-npm-e778fc5e2420)
-- [Glob Primer (node-glob)](https://github.com/isaacs/node-glob#glob-primer) (release-it uses
-  [globby](https://github.com/sindresorhus/globby#readme))
+[MIT](./LICENSE)

package/lib/plugin/GitRelease.js

@@ -10,7 +10,7 @@ class GitRelease extends GitBase {
   getInitialOptions(options) {
     const baseOptions = super.getInitialOptions(...arguments);
     const git = options.git || defaultConfig.git;
-    const gitOptions = _.pick(git, ['tagName', 'pushRepo', 'changelog']);
+    const gitOptions = _.pick(git, ['tagName', 'tagMatch', 'pushRepo', 'changelog']);
     return _.defaults(baseOptions, gitOptions);
   }
 

package/lib/plugin/github/GitHub.js

@@ -7,6 +7,7 @@ const _ = require('lodash');
 const retry = require('async-retry');
 const newGithubReleaseUrl = require('new-github-release-url');
 const open = require('open');
+const ProxyAgent = require('proxy-agent');
 const pkg = require('../../../package.json');
 const { format, parseVersion, e } = require('../../util');
 const Release = require('../GitRelease');
@@ -167,7 +168,7 @@ class GitHub extends Release {
     };
 
     if (proxy) {
-      options.proxy = proxy;
+      options.request.agent = new ProxyAgent(proxy);
     }
 
     const client = new Octokit(options);

package/lib/plugin/gitlab/GitLab.js

@@ -4,6 +4,7 @@ const got = require('got');
 const globby = require('globby');
 const FormData = require('form-data');
 const _ = require('lodash');
+const allSettled = require('promise.allsettled');
 const Release = require('../GitRelease');
 const { format, e } = require('../../util');
 const prompts = require('./prompts');
@@ -28,7 +29,7 @@ class GitLab extends Release {
     const { tokenHeader } = this.options;
     const { baseUrl } = this.getContext();
     this._client = got.extend({
-      prefixUrl: baseUrl,
+      baseUrl,
       method: 'POST',
       headers: {
         'user-agent': 'webpro/release-it',
@@ -127,7 +128,7 @@ class GitLab extends Release {
     const requests = releaseMilestones.map(milestone => {
       const options = {
         method: 'GET',
-        searchParams: {
+        query: {
           title: milestone,
           include_parent_milestones: true
         }
@@ -148,7 +149,7 @@ class GitLab extends Release {
       });
     });
     try {
-      await Promise.allSettled(requests).then(results => {
+      await allSettled(requests).then(results => {
         for (const result of results) {
           if (result.status === 'rejected') {
             throw e('Missing one or more milestones in GitLab. Creating a GitLab release will fail.', docs);
@@ -209,7 +210,8 @@ class GitLab extends Release {
 
     const endpoint = `projects/${id}/releases`;
     const options = {
-      json: {
+      json: true,
+      body: {
         name,
         tag_name: tagName,
         description
@@ -217,13 +219,13 @@ class GitLab extends Release {
     };
 
     if (this.assets.length) {
-      options.json.assets = {
+      options.body.assets = {
         links: this.assets
       };
     }
 
     if (releaseMilestones.length) {
-      options.json.milestones = releaseMilestones;
+      options.body.milestones = releaseMilestones;
     }
 
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.14.0",
+  "version": "14.14.3",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -65,9 +65,9 @@
     "form-data": "4.0.0",
     "git-url-parse": "11.6.0",
     "globby": "11.0.4",
-    "got": "11.8.3",
+    "got": "9.6.0",
     "import-cwd": "3.0.0",
-    "inquirer": "8.2.2",
+    "inquirer": "8.2.0",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
@@ -76,6 +76,8 @@
     "ora": "5.4.1",
     "os-name": "4.0.1",
     "parse-json": "5.2.0",
+    "promise.allsettled": "1.0.5",
+    "proxy-agent": "5.0.0",
     "semver": "7.3.5",
     "shelljs": "0.8.5",
     "update-notifier": "5.1.0",
@@ -88,22 +90,25 @@
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
-    "eslint": "8.12.0",
+    "eslint": "7.32.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-ava": "13.2.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-ava": "12.0.0",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.0.0",
     "markdown-toc": "1.2.0",
-    "mock-fs": "5.1.2",
+    "mock-fs": "4.14.0",
     "mock-stdio": "1.0.3",
     "nock": "13.2.4",
     "node-fetch": "2.6.7",
-    "prettier": "2.6.1",
+    "prettier": "2.6.2",
     "proxyquire": "2.1.3",
     "sinon": "13.0.1",
     "strip-ansi": "6.0.0"
   },
   "engines": {
     "node": ">=10"
+  },
+  "resolutions": {
+    "lru-cache": "6.0.0"
   }
 }

package/test/git.init.js

@@ -154,19 +154,13 @@ test.serial('should get the latest custom tag after fetch when tagName is config
 test.serial('should get the latest tag based on tagMatch', async t => {
   const shell = factory(Shell);
   const gitClient = factory(Git, {
-    options: { git: { tagMatch: '[0-9][0-9].[0-1][0-9].[0-9]*' } },
+    options: { git: { tagMatch: '[0-9][0-9]\\.[0-1][0-9]\\.[0-9]*' } },
     container: { shell }
   });
-  const { bare, target } = t.context;
-  const other = mkTmpDir();
-  sh.exec('git push');
-  sh.exec(`git clone ${bare} ${other}`);
-  sh.pushd('-q', other);
   sh.exec('git tag 1.0.0');
   sh.exec('git tag 21.04.3');
   sh.exec('git tag 1.0.1');
   sh.exec('git push --tags');
-  sh.pushd('-q', target);
   await gitClient.init();
   t.is(gitClient.config.getContext('latestTag'), '21.04.3');
 });
@@ -180,3 +174,21 @@ test.serial('should generate correct changelog', async t => {
   const changelog = await gitClient.getChangelog();
   t.regex(changelog, /\* Add file \(\w{7}\)\n\* Add file \(\w{7}\)/);
 });
+
+test.serial('should get the full changelog since latest major tag', async t => {
+  const shell = factory(Shell);
+  const gitClient = factory(Git, {
+    options: { git: { tagMatch: '[0-9]\\.[0-9]\\.[0-9]', changelog: git.changelog } },
+    container: { shell }
+  });
+  sh.exec('git tag 1.0.0');
+  gitAdd('line', 'file', 'Add file');
+  sh.exec('git tag 2.0.0-rc.0');
+  gitAdd('line', 'file', 'Add file');
+  sh.exec('git tag 2.0.0-rc.1');
+  gitAdd('line', 'file', 'Add file');
+  await gitClient.init();
+  t.is(gitClient.config.getContext('latestTag'), '1.0.0');
+  const changelog = await gitClient.getChangelog();
+  t.regex(changelog, /\* Add file \(\w{7}\)\n\* Add file \(\w{7}\)\n\* Add file \(\w{7}\)/);
+});

package/test/github.js

@@ -236,6 +236,7 @@ test('should release to alternative host and proxy', async t => {
   const { isReleased, releaseUrl } = github.getContext();
   t.true(isReleased);
   t.is(releaseUrl, `https://custom.example.org/user/repo/releases/tag/1.0.1`);
+  t.is(github.options.proxy, 'http://proxy:8080');
   exec.restore();
 });