folke/semantic-release-commit-filter

📦🕵️‍♀️ Semantic-release plugin that filters git commits based on the current working directory

🚀 🕵️‍♀️ Semantic-Release Commit Filter

This package is a shareable configuration for semantic-release that:

• configures tagFormat to use the package name from the current directory ${package.name}-v${version}
• uses commits only applicable to the current directory

❓ Why

Suppose you have a monorepo with two packages:

$ tree -P "package.json|release.config.js" -I node_modules mono-semver
mono-semver
├── package.json
├── packages
│   ├── pkg1
│   │   ├── package.json
│   │   └── release.config.js
│   └── pkg2
│       ├── package.json
│       └── release.config.js
└── release.config.js

3 directories, 6 files

Now we can run semantic-release in any of the package directories and/or in the top-level directory.

CHANGELOG.md files and package.json versions will be maintained in every directory.

📦 Installation

Make sure that if you have semantic-version installed globally, also install semantic-version-commit-filter globally. Same with local install.

$ npm install --dev semantic-version-commit-filter

$ yarn install --dev semantic-version-commit-filter

!! make sure you make semantic-release available in every package.json file. Additionally, every package directory needs its own semantic release configuration file.

⚙️ Configuration

You can either specify this packages in your release config file:

{
  "extends": ["semantic-release-commit-filter"]
}

or specify it as a paramater to the semantic-release cli

$ npx semantic-release -e semantic-release-commit-filter

semantic-release-commit-filter's Issues

why does this work? :)

Super curious - why does checking the require cache work for all file types? e.g. also changes on a readme.md gets picked up?
I thought this would do something like this under the hood:

git diff-tree --no-commit-id --name-only {hash-of-last-release-commit} -r

your approach is super interesting - and works for my first attempts :)

Invalid path to package.json resolving on windows

Trying to run in workspace root directory

posix.resolve(process.cwd(), "package.json")

Resolves to:

'/Dev/monorepo-playground/X:\\Dev\\monorepo-playground/package.json'

Next require fails with error Error: Cannot find module

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency @types/node to v13.9.8
• chore(deps): update dependency eslint to v9
• chore(deps): update dependency eslint-config-prettier to v9
• chore(deps): update dependency eslint-plugin-jest to v28
• chore(deps): update dependency eslint-plugin-prettier to v5
• chore(deps): update dependency eslint-plugin-promise to v6
• chore(deps): update dependency eslint-plugin-unicorn to v52
• chore(deps): update dependency husky to v9
• chore(deps): update dependency node to v20 (node, @types/node)
• chore(deps): update dependency prettier to v3
• chore(deps): update dependency rimraf to v5
• chore(deps): update dependency ts-node to v10
• chore(deps): update dependency typescript to v5
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• chore(deps): update dependency devmoji to v2.1.13
• chore(deps): update dependency eslint-plugin-import to v2.20.2
• chore(deps): update dependency eslint-plugin-prettier to v3.1.4
• chore(deps): update dependency husky to v4.2.5
• chore(deps): update dependency ts-node to v8.8.2
• chore(deps): update dependency tslib to v1.11.2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies (minor) (@types/node, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, devmoji, eslint-config-prettier, eslint-plugin-import, eslint-plugin-jest, eslint-plugin-node, eslint-plugin-prettier, eslint-plugin-promise, husky, jest, node, ts-jest, ts-node, tslib, typescript)
• chore(deps): update dependency tslib to v2
• chore(deps): update jest monorepo to v29 (major) (@types/jest, jest, ts-jest)
• chore(deps): update typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

npm

package.json

• @types/jest 24.9.1
• @types/node 13.9.4
• @typescript-eslint/eslint-plugin 2.25.0
• @typescript-eslint/parser 2.25.0
• devmoji 2.1.7
• eslint 6.8.0
• eslint-config-prettier 6.10.1
• eslint-plugin-import 2.20.1
• eslint-plugin-jest 23.8.2
• eslint-plugin-node 11.0.0
• eslint-plugin-prettier 3.1.2
• eslint-plugin-promise 4.2.1
• eslint-plugin-unicorn 15.0.1
• husky 4.2.3
• jest 25.1.0
• prettier 1.19.1
• rimraf 3.0.2
• ts-jest 25.2.1
• ts-node 8.8.1
• tslib 1.11.1
• typescript 3.8.3

nvm

.nvmrc

• node v13.11.0

---

• Check this box to trigger a request for Renovate to run again on this repository