Skip to content

Commit

Permalink
feat: adds support for GitHub links (see #13), great idea @bcoe!
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe committed Apr 10, 2016
1 parent 0c2cd70 commit 7bf6597
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Coverage Status](https://coveralls.io/repos/conventional-changelog/standard-version/badge.svg?branch=)](https://coveralls.io/r/conventional-changelog/standard-version?branch=master)
[![Standard Version](https://img.shields.io/badge/standard-version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)

> stop using `npm version`, use `standard-version` it makes your life way easier.
> stop using `npm version`, use `standard-version` it rocks!
Automatic release and CHANGELOG management, using GitHub's new squash button and
the workflow outlined in [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
Expand All @@ -22,7 +22,7 @@ _how it works:_
`standard-version` does the following:

1. bumps the version in package.json (based on your commit history).
2. runs `conventional-changelog` and updates _CHANGELOG.md._
2. uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) to update _CHANGELOG.md._
3. commits _package.json_ and _CHANGELOG.md_.
4. tags a new release.

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

`npm i standard-version -g`

## Automating

Do this:
_Or, add it as a development dependency like so:_

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

Add this to your _package.json_
_And add this to your _package.json:_

```json
{
Expand Down Expand Up @@ -81,6 +79,11 @@ You decide, e.g., docs, chore, etc.
git commit -a -m "docs: fixed up the docs a bit"
```

_but wait, there's more!_

Github usernames (`@bcoe`) and issue references (#133) will be swapped out for the
appropriate URLs in your CHANGELOG.

## Badges!

Tell your users that you adhere to the `standard-version` commit guidelines:
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"dependencies": {
"chalk": "^1.1.3",
"conventional-changelog": "^1.1.0",
"conventional-changelog-standard": "^1.1.0",
"conventional-changelog-standard": "^1.2.1",
"conventional-recommended-bump": "^0.2.0",
"figures": "^1.5.0",
"fs-access": "^1.0.0",
Expand All @@ -45,4 +45,4 @@
"shelljs": "^0.6.0",
"standard": "^6.0.8"
}
}
}

0 comments on commit 7bf6597

Please sign in to comment.