@rimac-technology/semantic-release-monorepo
v1.1.8
Published
Enhanced semantic-release by enabling simplified and automatic package publishing in multi-package repositories
Downloads
897
Maintainers
Readme
@rimac-technology/semantic-release-monorepo
Overview
This project is a TypeScript-enhanced version of the original semantic-release-monorepo. It leverages TypeScript for improved type safety and includes updates to dependencies, codebase simplification, and support for ECMAScript Modules (ESM).
Installation
Ensure both semantic-release
and semantic-release-monorepo
are accessible in each package of your monorepo.
Install the package as a development dependency using yarn:
yarn add --dev @rimac-technology/semantic-release-monorepo
or npm:
npm install --dev @rimac-technology/semantic-release-monorepo
Configuration
It is designed to integrate seamlessly with your current semantic-release workflow. Simply replace instances where you call the semantic-release CLI command with semantic-release-monorepo. For example, in your package.json's release script:
{
"scripts": {
"release": "semantic-release-monorepo"
}
}
Or, when using it in the CLI:
semantic-release-monorepo --extends @semantic-release/gitlab-config --dry-run
ℹ️ As the allowUnknownFlags is enabled, all flags will be passed to
internal semantic-release
call as options
argument.
How it works
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
| Filters context.commits
to only include the given monorepo package's commits.Modifies context.nextRelease.version
to use the monorepo git tag format. The wrapped (default) generateNotes
implementation uses this variable as the header for the release notes. Since all release notes end up in the same Git repository, using just the version as a header introduces ambiguity. |
tagFormat
To prevent version conflicts, git tags are created with a namespace that incorporates the name of the package, such as
[email protected]
. To change this default setting, specify a
tagFormat key in the .releaserc
.
⚠️ Remember, it's essential to choose a format that ensures each workspace/release is unique.