@psm14/semantic-release-path-filter 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,50 @@
+# semantic-release-path-filter
+
+A plugin for semantic-release that filters commits based on file paths before passing them to other semantic-release plugins.
+
+## Installation
+
+```bash
+npm install --save-dev @psm14/semantic-release-path-filter
+```
+
+## Usage
+
+This plugin wraps around other semantic-release plugins and filters the commits they receive based on file paths.
+
+```json
+{
+  "plugins": [
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/commit-analyzer"
+      }
+    ],
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/release-notes-generator"
+      }
+    ],
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/git"
+      }
+    ],
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/github"
+      }
+    ]
+  ]
+}
+```
+
+The `plugin` option may be a string or an array consisting of the name and a configuration object.

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@psm14/semantic-release-path-filter",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "README.md"
   ],
   "author": "Patrick McLaughlin <me@patmclaughl.in>",
   "license": "ISC",