release-it 15.9.3 → 15.10.1

package/README.md

@@ -20,19 +20,6 @@ system, and hooks to execute any command you need to test, build, and/or publish
 [![Action Status](https://github.com/release-it/release-it/workflows/Cross-OS%20Tests/badge.svg)](https://github.com/release-it/release-it/actions)
 [![npm version](https://badge.fury.io/js/release-it.svg)](https://www.npmjs.com/package/release-it)
 
-## Announcement
-
-The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for
-environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md).
-
-## Links
-
-- See [CHANGELOG.md](./CHANGELOG.md) for major/breaking updates, and
-  [releases](https://github.com/release-it/release-it/releases) for a detailed version history.
-- To **contribute**, please read [CONTRIBUTING.md](./.github/CONTRIBUTING.md) first.
-- Please [open an issue](https://github.com/release-it/release-it/issues/new) if anything is missing or unclear in this
-  documentation.
-
 ## Installation
 
 Although release-it is a **generic** release tool, most projects use it for projects with npm packages. The recommended
@@ -56,66 +43,45 @@ npm install -D release-it
     "release": "release-it"
   },
   "devDependencies": {
-    "release-it": "*"
+    "release-it": "^15.10.0"
   }
 }
 ```
 
-Now you can run `npm run release` from the command line (put release-it arguments behind the `-- `):
-
-```bash
-npm run release
-npm run release -- minor --ci
-```
-
-### Global Installation
-
-#### Using npx or npm
+## Usage
 
-Use npx to run release-it directly from anywhere:
+Run release-it from the root of the project using either `npm run` or `npx`:
 
 ```bash
+npm run release
 npx release-it
 ```
 
-Or use npm to install and run release-it globally:
-
-```bash
-npm install -g release-it
-```
-
-#### Using Homebrew
-
-```bash
-brew install release-it
-```
-
-## Usage
-
-Release a new version:
+You will be prompted to select the new version, and more prompts will follow based on your configuration.
 
-```bash
-release-it
-```
+## Yarn
 
-You will be prompted to select the new version, and more prompts will follow based on your configuration.
+Using Yarn? Please see the [npm section on Yarn](./docs/npm.md#yarn).
 
-Run release-it from the root of the project to prevent potential issues.
+## Global Installation
 
-## Dry Runs
+Per-project installation as shown above is recommended, but global installs are supported as well:
 
-Use `--dry-run` to show the interactivity and the commands it _would_ execute.
+- From npm: `npm install -g release-it`
+- From Homebrew: `brew install release-it`
 
-→ See [Dry Runs](./docs/dry-runs.md) for more details.
+## GitHub Actions
 
-To print the next version without releasing anything, add the `--release-version` flag.
+Want to use release-it with GitHub Actions to fully automate the whole process? Enjoy this great walk-through:
+[How to use GitHub Actions & Release-It to Easily Release Your Code](https://www.youtube.com/watch?v=7pBcuT7j_A0) (by
+[David from Kodaps](https://twitter.com/KodapsAcademy)).
 
-To print the changelog without releasing anything, add the `--changelog` flag.
+→ See [Continuous Integration environments](./docs/ci.md) for more details.
 
 ## Configuration
 
 Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Most
-projects use a `.release-it.json` in the project root, or a `release-it` property in `package.json`.
+projects use a `.release-it.json` file in the project root, or a `release-it` property in `package.json`.
 
 → See [Configuration](./docs/configuration.md) for more details.
 
@@ -198,7 +164,8 @@ changelog serves as the release notes for the GitHub or GitLab release.
 
 The [default command](./config/release-it.json) is based on `git log ...`. This setting (`git.changelog`) can be
 overridden. To further customize the release notes for the GitHub or GitLab release, there's `github.releaseNotes` or
-`gitlab.releaseNotes`. Make sure any of these commands output the changelog to `stdout`. Plugins are available for:
+`gitlab.releaseNotes`. Make sure any of these commands output the changelog to `stdout`. Note that release-it by default
+is agnostic to commit message conventions. Plugins are available for:
 
 - GitHub and GitLab Releases
 - auto-changelog
@@ -296,6 +263,24 @@ release-it --'hooks.after:release="echo Successfully released ${name} v${version
 
 Using Inquirer.js inside custom hook scripts might cause issues (since release-it also uses this itself).
 
+## Dry Runs
+
+Use `--dry-run` to show the interactivity and the commands it _would_ execute.
+
+→ See [Dry Runs](./docs/dry-runs.md) for more details.
+
+To print the next version without releasing anything, add the `--release-version` flag.
+
+To print the changelog without releasing anything, add the `--changelog` flag.
+
+## Troubleshooting & debugging
+
+- With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook](#hooks).
+- With `release-it -VV`, release-it also prints the output of every internal command.
+- Use `NODE_DEBUG=release-it:* release-it [...]` to print configuration and more error details.
+
+Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line.
+
 ## Plugins
 
 Since v11, release-it can be extended in many, many ways. Here are some plugins:
@@ -317,22 +302,6 @@ Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab
 
 → See [plugins](./docs/plugins.md) for documentation to write plugins.
 
-## Distribution repository
-
-Deprecated. Please see [distribution repository](./docs/recipes/distribution-repo.md) for more details.
-
-## Metrics
-
-In release-it v15, anonymous metrics have been removed from the codebase and no data is sent or stored anywhere.
-
-## Troubleshooting & debugging
-
-- With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook](#hooks).
-- With `release-it -VV`, release-it also prints the output of every internal command.
-- Use `NODE_DEBUG=release-it:* release-it [...]` to print configuration and more error details.
-
-Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line.
-
 ## Use release-it programmatically
 
 While mostly used as a CLI tool, release-it can be used as a dependency to integrate in your own scripts. See
@@ -361,6 +330,19 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [Repositories that depend on release-it](https://github.com/release-it/release-it/network/dependents)
 - GitHub search for [path:\*\*/.release-it.json](https://github.com/search?q=path%3A**%2F.release-it.json&type=code)
 
+## Legacy Node.js
+
+The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for
+environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md).
+
+## Links
+
+- See [CHANGELOG.md](./CHANGELOG.md) for major/breaking updates, and
+  [releases](https://github.com/release-it/release-it/releases) for a detailed version history.
+- To **contribute**, please read [CONTRIBUTING.md](./.github/CONTRIBUTING.md) first.
+- Please [open an issue](https://github.com/release-it/release-it/issues/new) if anything is missing or unclear in this
+  documentation.
+
 ## License
 
 [MIT](./LICENSE)

package/config/release-it.json

@@ -47,7 +47,12 @@
     "timeout": 0,
     "proxy": null,
     "skipChecks": false,
-    "web": false
+    "web": false,
+    "comments": {
+      "submit": false,
+      "issue": ":rocket: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._",
+      "pr": ":rocket: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._"
+    }
   },
   "gitlab": {
     "release": false,

package/lib/plugin/github/GitHub.js

@@ -12,6 +12,7 @@ import ProxyAgent from 'proxy-agent';
 import { format, parseVersion, readJSON, e } from '../../util.js';
 import Release from '../GitRelease.js';
 import prompts from './prompts.js';
+import { getCommitsFromChangelog, getResolvedIssuesFromChangelog, searchQueries } from './util.js';
 
 const pkg = readJSON(new URL('../../../package.json', import.meta.url));
 
@@ -142,7 +143,8 @@ class GitHub extends Release {
     } else {
       const release = async () => {
         await this[publishMethod]();
-        return this.uploadAssets();
+        await this.uploadAssets();
+        return isUpdate ? Promise.resolve() : this.commentOnResolvedItems();
       };
       return this.step({ task: release, label: `GitHub ${type} release`, prompt: 'release' });
     }
@@ -362,6 +364,37 @@ class GitHub extends Release {
       }
     });
   }
+
+  async commentOnResolvedItems() {
+    const { isDryRun } = this.config;
+    const { owner, project: repo } = this.getContext('repo');
+    const { changelog } = this.config.getContext();
+    const { comments } = this.options;
+    const { submit, issue, pr } = comments;
+    const context = this.getContext();
+
+    if (!submit || !changelog || isDryRun) return;
+
+    const shas = getCommitsFromChangelog(changelog);
+    const searchResults = await Promise.all(searchQueries(this.client, owner, repo, shas));
+    const mergedPullRequests = searchResults.flatMap(items => items.map(item => ({ type: 'pr', number: item.number })));
+
+    const host = 'https://' + (this.options.host || this.getContext('repo.host'));
+    const resolvedIssues = getResolvedIssuesFromChangelog(host, owner, repo, changelog);
+
+    for (const item of [...resolvedIssues, ...mergedPullRequests]) {
+      const { type, number } = item;
+      const comment = format(format(type === 'pr' ? pr : issue, context), context);
+      const url = `${host}/${owner}/${repo}/${type === 'pr' ? 'pull' : 'issues'}/${number}`;
+
+      try {
+        await this.client.issues.createComment({ owner, repo, issue_number: number, body: comment });
+        this.log.log(`● Commented on ${url}`);
+      } catch (error) {
+        this.log.log(`✕ Failed to comment on ${url}`);
+      }
+    }
+  }
 }
 
 export default GitHub;

package/lib/plugin/github/util.js

@@ -0,0 +1,39 @@
+// Totally much borrowed from https://github.com/semantic-release/github/blob/master/lib/success.js
+import issueParser from 'issue-parser';
+
+const getSearchQueries = (base, commits, separator = '+') => {
+  return commits.reduce((searches, commit) => {
+    const lastSearch = searches[searches.length - 1];
+    if (lastSearch && lastSearch.length + commit.length <= 256 - separator.length) {
+      searches[searches.length - 1] = `${lastSearch}${separator}${commit}`;
+    } else {
+      searches.push(`${base}${separator}${commit}`);
+    }
+
+    return searches;
+  }, []);
+};
+
+export const searchQueries = (client, owner, repo, shas) =>
+  getSearchQueries(`repo:${owner}/${repo}+type:pr+is:merged`, shas).map(
+    async q => (await client.search.issuesAndPullRequests({ q })).data.items
+  );
+
+export const getCommitsFromChangelog = changelog => {
+  const regex = /\(([a-f0-9]{7,})\)/i;
+  return changelog.split('\n').flatMap(message => {
+    const match = message.match(regex);
+    if (match) return match[1];
+    return [];
+  });
+};
+
+export const getResolvedIssuesFromChangelog = (host, owner, repo, changelog) => {
+  const parser = issueParser('github', { hosts: [host] });
+  return changelog
+    .split('\n')
+    .map(parser)
+    .flatMap(parsed => parsed.actions.close)
+    .filter(action => !action.slug || action.slug === `${owner}/${repo}`)
+    .map(action => ({ type: 'issue', number: parseInt(action.issue, 10) }));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.9.3",
+  "version": "15.10.1",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -70,11 +70,12 @@
     "got": "12.6.0",
     "inquirer": "9.1.5",
     "is-ci": "3.0.1",
+    "issue-parser": "6.0.0",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
     "node-fetch": "3.3.1",
-    "open": "9.0.0",
+    "open": "9.1.0",
     "ora": "6.3.0",
     "os-name": "5.1.0",
     "promise.allsettled": "1.0.6",
@@ -89,7 +90,7 @@
   "devDependencies": {
     "@octokit/request-error": "3.0.3",
     "ava": "5.2.0",
-    "eslint": "8.36.0",
+    "eslint": "8.37.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-ava": "14.0.0",
     "eslint-plugin-import": "2.27.5",
@@ -98,7 +99,7 @@
     "mock-stdio": "1.0.3",
     "nock": "13.3.0",
     "prettier": "2.8.7",
-    "sinon": "15.0.2",
+    "sinon": "15.0.3",
     "strip-ansi": "7.0.1"
   },
   "engines": {