Merge branch 'master' into fix/dev-deps

pmowrer · Jan 17, 2024 · e6dec8d · e6dec8d
2 parents b8e62e1 + 100c5b0
commit e6dec8d
Show file tree

Hide file tree

Showing 8 changed files with 746 additions and 2,891 deletions.
diff --git a/.github/workflows/release-preview.yml b/.github/workflows/release-preview.yml
@@ -0,0 +1,15 @@
+name: Release preview
+on: [pull_request]
+jobs:
+  release-preview:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      # semantic-release dry-run workaround https://github.com/semantic-release/semantic-release/issues/1890#issuecomment-974512960
+      - run: git checkout -b ${{ github.head_ref }}
+      - run: unset GITHUB_ACTIONS && npx semantic-release-github-pr --debug
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,19 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: npx semantic-release --debug
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,13 @@
+name: Tests
+on: [pull_request]
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Git credentials need to be set when testing git utils
+        run: git config --global user.email [email protected] && git config --global user.name "Test user"
+      - run: yarn && yarn test
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 # semantic-release-monorepo
 
-[![Build Status](https://travis-ci.org/pmowrer/semantic-release-monorepo.svg?branch=master)](https://travis-ci.org/pmowrer/semantic-release-monorepo) [![npm](https://img.shields.io/npm/v/semantic-release-monorepo.svg)](https://www.npmjs.com/package/semantic-release-monorepo) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+![Tests workflow](https://github.com/pmowrer/semantic-release-monorepo/actions/workflows/tests.yml/badge.svg) [![npm](https://img.shields.io/npm/v/semantic-release-monorepo.svg)](https://www.npmjs.com/package/semantic-release-monorepo) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 Apply [`semantic-release`'s](https://github.com/semantic-release/semantic-release) automatic publishing to a monorepo.
 
 ## Why
- The default configuration of `semantic-release` assumes a one-to-one relationship between a GitHub repository and an `npm` package.
+
+The default configuration of `semantic-release` assumes a one-to-one relationship between a GitHub repository and an `npm` package.
 
 This library allows using `semantic-release` with a single GitHub repository containing many `npm` packages.
 
@@ -18,6 +19,7 @@ If a commit touched a file in or below a package's root, it will be considered f
 In order to avoid version collisions, generated git tags are namespaced using the given package's name: `<package-name>-<version>`.
 
 ## Install
+
 Both `semantic-release` and `semantic-release-monorepo` must be accessible in each monorepo package.
 
 ```bash
@@ -29,11 +31,13 @@ npm install -D semantic-release semantic-release-monorepo
 Run `semantic-release` in an **individual monorepo package** and apply `semantic-release-monorepo` via the [`extends`](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#extends) option.
 
 On the command line:
+
 ```bash
 $ npm run semantic-release -e semantic-release-monorepo
 ```
 
 Or in the [release config](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration-file):
+
 ```json
 {
   "extends": "semantic-release-monorepo"
@@ -57,29 +61,31 @@ $ yarn workspaces run semantic-release -e semantic-release-monorepo
 ```
 
 ### With Lerna
+
 The monorepo management tool [`lerna`](https://github.com/lerna/lerna) can be used to run `semantic-release-monorepo` across all packages in a monorepo with a single command:
 
 ```bash
 lerna exec --concurrency 1 -- npx --no-install semantic-release -e semantic-release-monorepo
 ```
 
 ### With pnpm
+
 [pnpm](https://pnpm.io/) has built-in [workspace](https://pnpm.io/workspaces) functionality for monorepos. Similarly to the above, you can use pnpm to make release in all packages:
 
 ```bash
 pnpm -r --workspace-concurrency=1 exec -- npx --no-install semantic-release -e semantic-release-monorepo
 ```
 
- Thanks to how [`npx's package resolution works`](https://github.com/npm/npx#description), if the repository root is in `$PATH` (typically true on CI), `semantic-release` and `semantic-release-monorepo` can be installed once in the repo root instead of in each individual package, likely saving both time and disk space.
-
+Thanks to how [`npx's package resolution works`](https://github.com/npm/npx#description), if the repository root is in `$PATH` (typically true on CI), `semantic-release` and `semantic-release-monorepo` can be installed once in the repo root instead of in each individual package, likely saving both time and disk space.
 
 ## Advanced
+
 This library modifies the `context` object passed to `semantic-release` plugins in the following way to make them compatible with a monorepo.
 
-| Step               | Description                                                                                           |
-| ------------------ | ----------------------------------------------------------------------------------------------------- |
-| `analyzeCommits` | Filters `context.commits` to only include the given monorepo package's commits.                              |
-| `generateNotes`          | <ul><li>Filters `context.commits` to only include the given monorepo package's commits.</li><li>Modifies `context.nextRelease.version` to use the [monorepo git tag format](#how). The wrapped (default) `generateNotes` implementation uses this variable as the header for the release notes. Since all release notes end up in the same Github repository, using just the version as a header introduces ambiguity.</li></ul>   |
+| Step             | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `analyzeCommits` | Filters `context.commits` to only include the given monorepo package's commits.                                                                                                                                                                                                                                                                                                                                                  |
+| `generateNotes`  | <ul><li>Filters `context.commits` to only include the given monorepo package's commits.</li><li>Modifies `context.nextRelease.version` to use the [monorepo git tag format](#how). The wrapped (default) `generateNotes` implementation uses this variable as the header for the release notes. Since all release notes end up in the same Github repository, using just the version as a header introduces ambiguity.</li></ul> |
 
 ### tagFormat
 
@@ -91,4 +97,4 @@ If you are using Lerna, you can customize the format using the following command
 "semantic-release": "lerna exec --concurrency 1 -- semantic-release -e semantic-release-monorepo --tag-format='${LERNA_PACKAGE_NAME}-v\\${version}'"
 ```
 
-Where `'${LERNA_PACKAGE_NAME}-v\\${version}'` is the string you want to customize.   By default it will be `<PACKAGE_NAME>-v<VERSION>` (e.g. `foobar-v1.2.3`).
+Where `'${LERNA_PACKAGE_NAME}-v\\${version}'` is the string you want to customize. By default it will be `<PACKAGE_NAME>-v<VERSION>` (e.g. `foobar-v1.2.3`).
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "semantic-release": ">=15.11.x"
+    "semantic-release": ">=15.11.x < 20"
   },
   "dependencies": {
     "debug": "^3.1.0",
@@ -34,9 +34,9 @@
     "husky": "^4.2.1",
     "jest": "^25.1.0",
     "lint-staged": "^10.0.7",
+    "p-each-series": "^2.1.0",
     "prettier": "^1.19.1",
-    "semantic-release": "^17.0.2",
-    "semantic-release-github-pr": "^6.0.0"
+    "tempy": "1.0.1"
   },
   "husky": {
     "hooks": {

diff --git a/src/index.js b/src/index.js
@@ -1,6 +1,6 @@
 const readPkg = require('read-pkg');
 const { compose } = require('ramda');
-const withOnlyPackageCommits = require('./only-package-commits');
+const { withOnlyPackageCommits } = require('./only-package-commits');
 const versionToGitTag = require('./version-to-git-tag');
 const logPluginVersion = require('./log-plugin-version');
 const { wrapStep } = require('semantic-release-plugin-decorators');