# prodent-multi-semantic-release > hacky [semantic-release](https://github.com/semantic-release/semantic-release) for monorepos Latest version **0.0.2** (published 2023-12-17) · 0BSD license · 0 weekly downloads ## Install ```sh npm install prodent-multi-semantic-release pnpm add prodent-multi-semantic-release yarn add prodent-multi-semantic-release bun add prodent-multi-semantic-release ``` Provides the command `multi-semantic-release`. ## Health **Score 20/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities. Warnings: low downloads; no types; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.2 | | Published | 2023-12-17 | | First published | 2023-12-17 | | Weekly downloads | 0 | | License | 0BSD | | TypeScript types | none | | Module format | ESM | | Node | >=14 | | Dependencies | 17 | | Unpacked size | 69 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Dave Houlbrooke | | Maintainers | mksavin | ## Links - npm: https://www.npmjs.com/package/prodent-multi-semantic-release - npm.io page: https://npm.io/package/prodent-multi-semantic-release ## Dependencies (17) - [meow](https://npm.io/package/meow.md) ^12.0.1 - [blork](https://npm.io/package/blork.md) ^9.3.0 - [debug](https://npm.io/package/debug.md) ^4.3.4 - [execa](https://npm.io/package/execa.md) ^7.1.1 - [semver](https://npm.io/package/semver.md) ^7.5.3 - [signale](https://npm.io/package/signale.md) ^1.4.0 - [lodash-es](https://npm.io/package/lodash-es.md) ^4.17.21 - [get-stream](https://npm.io/package/get-stream.md) ^6.0.1 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^8.3.6 - [resolve-from](https://npm.io/package/resolve-from.md) ^5.0.0 - [detect-indent](https://npm.io/package/detect-indent.md) ^7.0.1 - [detect-newline](https://npm.io/package/detect-newline.md) ^4.0.1 - [git-log-parser](https://npm.io/package/git-log-parser.md) ^1.2.0 - [promise-events](https://npm.io/package/promise-events.md) ^0.2.4 - [stream-buffers](https://npm.io/package/stream-buffers.md) ^3.0.2 - [semantic-release](https://npm.io/package/semantic-release.md) ^21.0.5 - [@semrel-extra/topo](https://npm.io/package/@semrel-extra/topo.md) ^1.14.0 ## Recent versions - 0.0.2 (latest) — 2023-12-17 - 0.0.1 — 2023-12-17 ## README # prodent-multi-semantic-release hacky [semantic-release](https://github.com/semantic-release/semantic-release) for monorepos [![npm (scoped)](https://img.shields.io/npm/v/@prodentinc/multi-semantic-release)](https://www.npmjs.com/package/@qiwi/multi-semantic-release) This fork of [qiwi/multi-semantic-release](https://github.com/dhoulb/multi-semantic-release) with additional release information and fixes 🎉 🎉 🎉 ## Install ```sh bun add prodent-multi-semantic-release --dev ``` ```sh npm i -D prodent-multi-semantic-release ``` ## Usage ```sh multi-semantic-release ``` ## Pipelines ### Create release meta file Run command: ```sh multi-semantic-release --dry-run --release-meta ``` Will output a `.release.json` file with release meta-data and version changes. ### Process only filtered elements Create filter file `.release-filter.json` with contents: ```json { "filter": [ "ui", "web" ] } ``` Run command: ```sh multi-semantic-release --filter-files=./.release-filter.json ``` Will process and create tags only for `ui` and `web` packages. ## Configuring Multi-Semantic-Release multi-semantic-release can be configured a number of ways: * A `.multi-releaserc` file, written in YAML or JSON, with optional extensions: `.yaml`/ `.yml`/ `.json`/ `.js` * A `multi-release.config.js` file that exports an object * A `multi-release` key in the workspace root package.json Alternatively some options may be set via CLI flags. **Note:** CLI arguments take precedence over options configured in the configuration file. ### Options | Option | Type | CLI Flag | Description | |-------------------|-------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | dryRun | `boolean` | `--dry-run` | Dry run mode. | | logLevel | `String` | `--log-level` | Sets the internal logger verbosity level: `error, warn, info, debug, trace`. Defaults to `info`. | | debug | `boolean` | `--debug` | Output debugging information. Shortcut for `--logLevel=debug`. | | silent | `boolean` | `--silent` | Turns off any log outputs. | | extends | `String \| Array` | N/A | List of modules or file paths containing a shareable configuration. If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in the previous. | | sequentialInit | `boolean` | `--sequential-init` | Avoid hypothetical concurrent initialization collisions. | | sequentialPrepare | `boolean` | `--sequential-prepare` | Avoid hypothetical concurrent preparation collisions. **True by default.** | | firstParent | `boolean` | `--first-parent` | Apply commit filtering to current branch only. | | ignorePrivate | `boolean` | `--ignore-private` | Exclude private packages. **True by default.** | | ignorePackages | `String \| Array` | `--ignore-packages` | Packages list to be ignored on bumping process (appended to the ones that already exist at package.json workspaces). If using the CLI flag, supply a comma seperated list of strings. | | tagFormat | `String` | `--tag-format` | Format to use when creating tag names. Should include "name" and "version" vars. Default: `"${name}@${version}"` which generates "package-name@1.0.0" | | deps | `Object` | N/A | Dependency handling, see below for possible values. | ### `deps` Options | Option | Type | CLI Flag | Description | |-----------------------|--------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | bump | `override \| satisfy \| inherit` | `--deps.bump` | Define deps version updating rule. Allowed: override, satisfy, inherit. **`override` by default.** | | release | `patch \| minor \| major \| inherit` | `--deps.release` | Define release type for dependent package if any of its deps changes. Supported values: patch, minor, major, inherit. **`patch` by default** | | prefix | `'^' \| '~' \| ''` | `--deps.prefix` | Optional prefix to be attached to the next version if `bump` is set to `override`. **`''` by default**. | | pullTagsForPrerelease | `boolean` | `--deps.pullTagsForPrerelease` | Optional flag to use release tags for evaluating prerelease version bumping. Normally, this option will lead to dumping dependencies to a version past what was just released and tagged by semantic release. Only set this option to true if you previously had a workflow that compensated for the previous bug behavior. **`'false'` by default**. | ### Examples * Via multi-release key in the project's package.json file: ```json { "multi-release": { "ignorePackages": [ "!packages/b/**", "!packages/c/**" ], "deps": { "bump": "inherit" } } } ``` * Via `.multi-releaserc` file: ```json { "ignorePackages": [ "!packages/b/**", "!packages/c/**" ], "deps": { "bump": "inherit" } } ``` * Via CLI: ```sh $ multi-semantic-release --ignore-packages=packages/a/**,packages/b/** --deps.bump=inherit ``` ## Configuring Semantic-Release **MSR** requires **semrel** config to be added [in any supported format](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration) for each package or/and declared in repo root (`globalConfig` is extremely useful if all the modules have the same strategy of release). NOTE config resolver joins `globalConfig` and `packageConfig` during execution. ```javascript // Load the package-specific options. const { options: pkgOptions } = await getConfig(dir); // The 'final options' are the global options merged with package-specific options. // We merge this ourselves because package-specific options can override global options. const finalOptions = Object.assign({}, globalOptions, pkgOptions); ``` Make sure to have a `workspaces` attribute inside your `package.json` project file. In there, you can set a list of packages that you might want to process in the msr process, as well as ignore others. For example, let's say your project has 4 packages (i.e. a, b, c and d) and you want to process only a and d (ignore b and c). You can set the following structure in your `package.json` file: ```json { "name": "msr-test-yarn", "author": "Dave Houlbrooke =8.3" }, "workspaces": [ "packages/*", "!packages/b/**", "!packages/c/**" ], "release": { "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator" ], "noCi": true } } ``` You can also ignore it with the CLI: ```bash $ multi-semantic-release --ignore-packages=packages/b/**,packages/c/** ``` You can also combine the CLI ignore options with the `!` operator at each package inside `workspaces` attribute. Even though you can use the CLI to ignore options, you can't use it to set which packages to be released – i.e. you still need to set the `workspaces` attribute inside the `package.json`. ## Verified usage examples We use this tool to release our JS platform code inhouse (GitHub Enterprise + JB TeamCity) and for our OSS (GitHub + Travis CI). Guaranteed working configurations available in projects. * [qiwi/substrate](https://github.com/qiwi/substrate) * [qiwi/json-rpc](https://github.com/qiwi/json-rpc) * [qiwi/lint-config-qiwi](https://github.com/qiwi/lint-config-qiwi) ## License [0BSD](./LICENSE.md) --- _Source: https://npm.io/package/prodent-multi-semantic-release · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._