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
BREAKING CHANGE:
Move to conventional-changelog-standard style. This style lifts the character limit on commit messages, and puts us in a position to make more opinionated decisions in the future.
> stop using `npm version`, use `standard-version` it does so much more:
8
+
> stop using `npm version`, use `standard-version` it makes your life way easier.
9
9
10
10
Automatic release and CHANGELOG management, using GitHub's new squash button and
11
-
the workflow outlined in [conventional-changelog-cli](https://github.com/stevemao/conventional-changelog-cli).
11
+
the workflow outlined in [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
12
12
13
-
**how it works:**
13
+
_how it works:_
14
14
15
15
1. when you land commits on your `master` branch, select the _Squash and Merge_ option.
16
-
2. add a title and body that follows the [conventional-changelog conventions](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md).
16
+
2. add a title and body that follows the [conventional-changelog-standard conventions](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
17
17
3. when you're ready to release to npm:
18
18
1. checkout `master`.
19
19
2. run `standard-version`.
@@ -22,7 +22,7 @@ the workflow outlined in [conventional-changelog-cli](https://github.com/stevema
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. runs `conventional-changelog` and updates _CHANGELOG.md._
26
26
3. commits _package.json_ and _CHANGELOG.md_.
27
27
4. tags a new release.
28
28
@@ -34,7 +34,7 @@ When you're generating your changelog for the first time, simply do:
34
34
35
35
## Installation
36
36
37
-
`npm i standard-version`
37
+
`npm i standard-version -g`
38
38
39
39
## Automating
40
40
@@ -52,6 +52,35 @@ Add this to your _package.json_
52
52
}
53
53
```
54
54
55
+
## Commit Message Convention, at a Glance
56
+
57
+
_patches:_
58
+
59
+
```sh
60
+
-m "fix(parsing): fixed a bug in our parser"
61
+
```
62
+
63
+
_features:_
64
+
65
+
```sh
66
+
git commit -a -m "feat(parser): we now have a parser \o/"
67
+
```
68
+
69
+
_breaking changes:_
70
+
71
+
```sh
72
+
git commit -a -m "feat(new-parser):
73
+
BREAKING CHANGE: swapping out our old parser for a new one"
74
+
```
75
+
76
+
_other changes:_
77
+
78
+
You decide, e.g., docs, chore, etc.
79
+
80
+
```sh
81
+
git commit -a -m "docs: fixed up the docs a bit"
82
+
```
83
+
55
84
## Badges!
56
85
57
86
Tell your users that you adhere to the `standard-version` commit guidelines:
describe: 'Name of the preset you want to use. Must be one of the following:\nangular, atom, codemirror, ember, eslint, express, jquery, jscs, or jshint',
16
-
default: 'angular',
17
-
global: true
18
-
})
19
13
.option('message',{
20
14
alias: 'm',
21
15
describe: 'Commit message, replaces %s with new version',
@@ -48,7 +42,7 @@ var semver = require('semver')
48
42
varutil=require('util')
49
43
50
44
conventionalRecommendedBump({
51
-
preset: argv.preset
45
+
preset: 'angular'
52
46
},function(err,release){
53
47
if(err){
54
48
console.error(chalk.red(err.message))
@@ -82,7 +76,7 @@ function outputChangelog (argv, cb) {
0 commit comments