You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> stop using `npm version`, use `standard-version` it makes your life way easier.
8
+
> stop using `npm version`, use `standard-version` it rocks!
9
9
10
10
Automatic release and CHANGELOG management, using GitHub's new squash button and
11
11
the workflow outlined in [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
@@ -22,7 +22,7 @@ _how it works:_
22
22
`standard-version` does the following:
23
23
24
24
1. bumps the version in package.json (based on your commit history).
25
-
2.runs `conventional-changelog` and updates_CHANGELOG.md._
25
+
2.uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) to update_CHANGELOG.md._
26
26
3. commits _package.json_ and _CHANGELOG.md_.
27
27
4. tags a new release.
28
28
@@ -36,13 +36,11 @@ When you're generating your changelog for the first time, simply do:
36
36
37
37
`npm i standard-version -g`
38
38
39
-
## Automating
40
-
41
-
Do this:
39
+
_Or, add it as a development dependency like so:_
42
40
43
41
`npm i standard-version --save-dev`
44
42
45
-
Add this to your _package.json_
43
+
_And add this to your _package.json:_
46
44
47
45
```json
48
46
{
@@ -81,6 +79,11 @@ You decide, e.g., docs, chore, etc.
81
79
git commit -a -m "docs: fixed up the docs a bit"
82
80
```
83
81
82
+
_but wait, there's more!_
83
+
84
+
Github usernames (`@bcoe`) and issue references (#133) will be swapped out for the
85
+
appropriate URLs in your CHANGELOG.
86
+
84
87
## Badges!
85
88
86
89
Tell your users that you adhere to the `standard-version` commit guidelines:
0 commit comments