This module was forked from the amazing
semantic-release-monorepo
. The original module is old and out dated. It was very easy to fork and amend. I needed to update it and support typescript to use it properly in typescript projects.
Apply semantic-release
's automatic publishing to a monorepo.
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.
Instead of attributing all commits to a single package, commits are assigned to packages based on the files that a commit touched.
If a commit touched a file in or below a package's root, it will be considered for that package's next release. A single commit can belong to multiple packages and may trigger the release of multiple packages.
In order to avoid version collisions, generated git tags are namespaced using the given package's name: <package-name>-<version>
.
Both semantic-release
and semantic-release-multi
must be accessible in each monorepo package.
npm install -D semantic-release semantic-release-multi
Run semantic-release
in an individual monorepo package and apply semantic-release-multi
via the extends
option.
On the command line:
$ npm run semantic-release -e semantic-release-multi
Or in the release config:
{
"extends": "semantic-release-multi"
}
NOTE: This library CAN'T be applied via the plugins
option.
{
"plugins": [
"semantic-release-multi" // This WON'T work
]
}
$ yarn workspaces run semantic-release -e semantic-release-multi
The monorepo management tool lerna
can be used to run semantic-release-multi
across all packages in a monorepo with a single command:
lerna exec --concurrency 1 -- npx --no-install semantic-release -e semantic-release-multi
pnpm has built-in workspace functionality for monorepos. Similarly to the above, you can use pnpm to make release in all packages:
pnpm -r --workspace-concurrency=1 exec -- npx --no-install semantic-release -e semantic-release-multi
Thanks to how npx's package resolution works
, if the repository root is in $PATH
(typically true on CI), semantic-release
and semantic-release-multi
can be installed once in the repo root instead of in each individual package, likely saving both time and disk space.
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 |
|
Pre-configures the tagFormat
option to use the monorepo git tag format.
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-multi --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
).