standard-changelog 8.0.0 → 8.0.1
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 +3 -28
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -31,15 +31,6 @@
|
|
|
31
31
|
|
|
32
32
|
An opinionated approach to CHANGELOG generation using angular commit conventions.
|
|
33
33
|
|
|
34
|
-
<hr />
|
|
35
|
-
<a href="#install">Install</a>
|
|
36
|
-
<span> • </span>
|
|
37
|
-
<a href="#usage">Usage</a>
|
|
38
|
-
<span> • </span>
|
|
39
|
-
<a href="#js-api">JS API</a>
|
|
40
|
-
<br />
|
|
41
|
-
<hr />
|
|
42
|
-
|
|
43
34
|
## Install
|
|
44
35
|
|
|
45
36
|
```bash
|
|
@@ -59,19 +50,9 @@ standard-changelog
|
|
|
59
50
|
|
|
60
51
|
The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
|
|
61
52
|
|
|
62
|
-
**your first release:**
|
|
63
|
-
|
|
64
|
-
If you're using this tool for the first time and want to generate new content in CHANGELOG.md, you can run:
|
|
65
|
-
|
|
66
|
-
```sh
|
|
67
|
-
standard-changelog --first-release
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
**advanced topics:**
|
|
71
|
-
|
|
72
53
|
All available command line parameters can be listed using CLI: `standard-changelog --help`.
|
|
73
54
|
|
|
74
|
-
|
|
55
|
+
JS API is also available:
|
|
75
56
|
|
|
76
57
|
```js
|
|
77
58
|
import { StandardChangelog } from 'standard-changelog'
|
|
@@ -82,17 +63,11 @@ const generator = new StandardChangelog()
|
|
|
82
63
|
generator
|
|
83
64
|
.writeStream()
|
|
84
65
|
.pipe(process.stdout)
|
|
85
|
-
|
|
86
|
-
// or
|
|
87
|
-
|
|
88
|
-
for await (const chunk of generator.write()) {
|
|
89
|
-
console.log(chunk)
|
|
90
|
-
}
|
|
91
66
|
```
|
|
92
67
|
|
|
93
|
-
|
|
68
|
+
## Documentation
|
|
94
69
|
|
|
95
|
-
|
|
70
|
+
For comprehensive guides, CLI options, and API reference, visit the [documentation website](https://conventional-changelog.js.org/standard-changelog/).
|
|
96
71
|
|
|
97
72
|
## License
|
|
98
73
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "standard-changelog",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "8.0.
|
|
4
|
+
"version": "8.0.1",
|
|
5
5
|
"description": "Generate a changelog from git metadata with Angular commit convention.",
|
|
6
6
|
"author": "Steve Mao",
|
|
7
7
|
"license": "MIT",
|
|
8
|
-
"homepage": "https://
|
|
8
|
+
"homepage": "https://conventional-changelog.js.org/standard-changelog/",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
11
|
"url": "https://github.com/conventional-changelog/conventional-changelog.git",
|
|
@@ -33,9 +33,9 @@
|
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"meow": "^14.0.0",
|
|
36
|
-
"
|
|
37
|
-
"conventional-changelog-
|
|
38
|
-
"conventional-changelog": "^8.0.
|
|
36
|
+
"conventional-changelog-angular": "^9.2.1",
|
|
37
|
+
"@conventional-changelog/git-client": "^3.0.2",
|
|
38
|
+
"conventional-changelog": "^8.0.1"
|
|
39
39
|
},
|
|
40
40
|
"bin": {
|
|
41
41
|
"standard-changelog": "./dist/cli.js"
|