@psm14/semantic-release-path-filter 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +50 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# semantic-release-path-filter
|
|
2
|
+
|
|
3
|
+
A plugin for semantic-release that filters commits based on file paths before passing them to other semantic-release plugins.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install --save-dev @psm14/semantic-release-path-filter
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
This plugin wraps around other semantic-release plugins and filters the commits they receive based on file paths.
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"plugins": [
|
|
18
|
+
[
|
|
19
|
+
"@psm14/semantic-release-path-filter",
|
|
20
|
+
{
|
|
21
|
+
"path": "plugin",
|
|
22
|
+
"plugin": "@semantic-release/commit-analyzer"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
[
|
|
26
|
+
"@psm14/semantic-release-path-filter",
|
|
27
|
+
{
|
|
28
|
+
"path": "plugin",
|
|
29
|
+
"plugin": "@semantic-release/release-notes-generator"
|
|
30
|
+
}
|
|
31
|
+
],
|
|
32
|
+
[
|
|
33
|
+
"@psm14/semantic-release-path-filter",
|
|
34
|
+
{
|
|
35
|
+
"path": "plugin",
|
|
36
|
+
"plugin": "@semantic-release/git"
|
|
37
|
+
}
|
|
38
|
+
],
|
|
39
|
+
[
|
|
40
|
+
"@psm14/semantic-release-path-filter",
|
|
41
|
+
{
|
|
42
|
+
"path": "plugin",
|
|
43
|
+
"plugin": "@semantic-release/github"
|
|
44
|
+
}
|
|
45
|
+
]
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The `plugin` option may be a string or an array consisting of the name and a configuration object.
|