@jeromefitz/conventional-gitmoji 3.0.0-contribs.2 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# @jeromefitz/conventional-gitmoji
|
|
2
2
|
|
|
3
|
-
🌉️ A bridge between `gitmoji` and `conventional-commits` configured for `semantic-release`.
|
|
3
|
+
1. 🌉️ A bridge between `gitmoji` and `conventional-commits` configured for `semantic-release`.
|
|
4
|
+
2. 🛠️ A `conventional-changelog` plugin for `semantic-release`.
|
|
4
5
|
|
|
5
6
|
## Usage
|
|
6
7
|
|
|
@@ -13,10 +14,33 @@ import { releaseRules, typeSpecs, types } from '@jeromefitz/conventional-gitmoji
|
|
|
13
14
|
```
|
|
14
15
|
|
|
15
16
|
- `releaseRules`: informs `@semantic-release/commit-analyzer`
|
|
16
|
-
- `typeSpecs`: informs `@
|
|
17
|
+
- `typeSpecs`: informs `@jeromefitz/release-notes-generator` (via `writerOpts`)
|
|
17
18
|
- `@hack`: This informs three different ways to ensure we catch the change from `gitmoji` to `conventional`
|
|
18
19
|
- `types`: informs `@jeromefitz/git-cz` for the `gitmoji` theme.
|
|
19
20
|
|
|
21
|
+
### Commit Analyzer
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
[
|
|
25
|
+
'@semantic-release/commit-analyzer',
|
|
26
|
+
{
|
|
27
|
+
config: '@jeromefitz/conventional-gitmoji',
|
|
28
|
+
releaseRules,
|
|
29
|
+
},
|
|
30
|
+
]
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Release Notes Generator
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
[
|
|
37
|
+
'@jeromefitz/release-notes-generator',
|
|
38
|
+
{
|
|
39
|
+
config: '@jeromefitz/conventional-gitmoji',
|
|
40
|
+
},
|
|
41
|
+
]
|
|
42
|
+
```
|
|
43
|
+
|
|
20
44
|
## Overview
|
|
21
45
|
|
|
22
46
|
### 😄️ gitmoji
|