Skip to content

Commit 1f673c0

Browse files
committed
feat(rebrand): rebrand recommended-workflow to standard-version (#9)
1 parent 9fadc5f commit 1f673c0

File tree

2 files changed

+22
-17
lines changed

2 files changed

+22
-17
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# Conventional Recommended Workflow
1+
# Standard Version
22

3-
[![Build Status](https://travis-ci.org/bcoe/conventional-recommended-workflow.svg)](https://travis-ci.org/bcoe/conventional-recommended-workflow)
4-
[![NPM version](https://img.shields.io/npm/v/conventional-recommended-workflow.svg)](https://www.npmjs.com/package/conventional-recommended-workflow)
3+
[![Build Status](https://travis-ci.org/conventional-changelog/standard-version.svg)](https://travis-ci.org/conventional-changelog/standard-version)
4+
[![NPM version](https://img.shields.io/npm/v/standard-version.svg)](https://www.npmjs.com/package/standard-version)
55

6-
Automatic CHANGELOG.md generation, using GitHub's new squash button and
6+
> stop using `npm version`, use `standard-version` it does so much more:
7+
8+
Automatic release and CHANGELOG management, using GitHub's new squash button and
79
the workflow outlined in [conventional-changelog-cli](https://github.com/stevemao/conventional-changelog-cli).
810

911
**how it works:**
@@ -12,12 +14,12 @@ the workflow outlined in [conventional-changelog-cli](https://github.com/stevema
1214
2. add a title and body that follows the [conventional-changelog conventions](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md).
1315
3. when you're ready to release to npm:
1416
1. checkout `master`.
15-
2. run `conventional-recommended-workflow`.
17+
2. run `standard-version`.
1618
3. `git push --tags; git push origin master; npm publish`.
1719

18-
`conventional-recommended-workflow` does the following:
20+
`standard-version` does the following:
1921

20-
1. bumps the version in package.json
22+
1. bumps the version in package.json (based on your commit history).
2123
2. runs `conventional-changelog` and updates CHANGELOG.md.
2224
3. commits _package.json_ and _CHANGELOG.md_.
2325
4. tags a new release.
@@ -26,11 +28,11 @@ the workflow outlined in [conventional-changelog-cli](https://github.com/stevema
2628

2729
When you're generating your changelog for the first time, simply do:
2830

29-
`conventional-recommended-workflow --first-release`
31+
`standard-version --first-release`
3032

3133
## Installation
3234

33-
`npm i conventional-recommended-workflow`
35+
`npm i standard-version`
3436

3537
## Automating
3638

@@ -39,7 +41,7 @@ Add this to your _package.json_
3941
```json
4042
{
4143
"scripts": {
42-
"release": "conventional-recommended-workflow"
44+
"release": "standard-version"
4345
}
4446
}
4547
```

package.json

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
{
2-
"name": "conventional-recommended-workflow",
2+
"name": "standard-version",
33
"version": "1.0.0",
4-
"description": "apply the recommended workflow outlined in conventional-changelog-cli.",
4+
"description": "replacement for `npm version` with automatic CHANGELOG generation",
55
"bin": "index.js",
6-
"main": "index.js",
76
"scripts": {
87
"test": "standard"
98
},
109
"repository": {
1110
"type": "git",
12-
"url": "git+https://github.com/bcoe/conventional-recommended-workflow.git"
11+
"url": "git+https://github.com/conventional-changelog/standard-verison.git"
1312
},
1413
"keywords": [
1514
"conventional-changelog",
1615
"recommended",
17-
"workflow"
16+
"changelog",
17+
"automatic",
18+
"workflow",
19+
"version",
20+
"angular"
1821
],
1922
"author": "Ben Coe <[email protected]>",
2023
"license": "ISC",
2124
"bugs": {
22-
"url": "https://github.com/bcoe/conventional-recommended-workflow/issues"
25+
"url": "https://github.com/conventional-changelog/standard-version/issues"
2326
},
24-
"homepage": "https://github.com/bcoe/conventional-recommended-workflow#readme",
27+
"homepage": "https://github.com/conventional-changelog/standard-version#readme",
2528
"dependencies": {
2629
"add-stream": "^1.0.0",
2730
"chalk": "^1.1.3",

0 commit comments

Comments
 (0)