Skip to content

Commit 7bf6597

Browse files
committed
feat: adds support for GitHub links (see #13), great idea @bcoe!
1 parent 0c2cd70 commit 7bf6597

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Coverage Status](https://coveralls.io/repos/conventional-changelog/standard-version/badge.svg?branch=)](https://coveralls.io/r/conventional-changelog/standard-version?branch=master)
66
[![Standard Version](https://img.shields.io/badge/standard-version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
77

8-
> stop using `npm version`, use `standard-version` it makes your life way easier.
8+
> stop using `npm version`, use `standard-version` it rocks!
99
1010
Automatic release and CHANGELOG management, using GitHub's new squash button and
1111
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:_
2222
`standard-version` does the following:
2323

2424
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._
2626
3. commits _package.json_ and _CHANGELOG.md_.
2727
4. tags a new release.
2828

@@ -36,13 +36,11 @@ When you're generating your changelog for the first time, simply do:
3636

3737
`npm i standard-version -g`
3838

39-
## Automating
40-
41-
Do this:
39+
_Or, add it as a development dependency like so:_
4240

4341
`npm i standard-version --save-dev`
4442

45-
Add this to your _package.json_
43+
_And add this to your _package.json:_
4644

4745
```json
4846
{
@@ -81,6 +79,11 @@ You decide, e.g., docs, chore, etc.
8179
git commit -a -m "docs: fixed up the docs a bit"
8280
```
8381

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+
8487
## Badges!
8588

8689
Tell your users that you adhere to the `standard-version` commit guidelines:

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"dependencies": {
3131
"chalk": "^1.1.3",
3232
"conventional-changelog": "^1.1.0",
33-
"conventional-changelog-standard": "^1.1.0",
33+
"conventional-changelog-standard": "^1.2.1",
3434
"conventional-recommended-bump": "^0.2.0",
3535
"figures": "^1.5.0",
3636
"fs-access": "^1.0.0",
@@ -45,4 +45,4 @@
4545
"shelljs": "^0.6.0",
4646
"standard": "^6.0.8"
4747
}
48-
}
48+
}

0 commit comments

Comments
 (0)