From 1f673c002e89b162ff074c9c6fb057f9c3dddea6 Mon Sep 17 00:00:00 2001 From: "Benjamin E. Coe" Date: Thu, 7 Apr 2016 21:47:31 -0700 Subject: [PATCH] feat(rebrand): rebrand recommended-workflow to standard-version (#9) --- README.md | 22 ++++++++++++---------- package.json | 17 ++++++++++------- 2 files changed, 22 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 35c0033d2..186da6844 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# Conventional Recommended Workflow +# Standard Version -[![Build Status](https://travis-ci.org/bcoe/conventional-recommended-workflow.svg)](https://travis-ci.org/bcoe/conventional-recommended-workflow) -[![NPM version](https://img.shields.io/npm/v/conventional-recommended-workflow.svg)](https://www.npmjs.com/package/conventional-recommended-workflow) +[![Build Status](https://travis-ci.org/conventional-changelog/standard-version.svg)](https://travis-ci.org/conventional-changelog/standard-version) +[![NPM version](https://img.shields.io/npm/v/standard-version.svg)](https://www.npmjs.com/package/standard-version) -Automatic CHANGELOG.md generation, using GitHub's new squash button and +> stop using `npm version`, use `standard-version` it does so much more: + +Automatic release and CHANGELOG management, using GitHub's new squash button and the workflow outlined in [conventional-changelog-cli](https://github.com/stevemao/conventional-changelog-cli). **how it works:** @@ -12,12 +14,12 @@ the workflow outlined in [conventional-changelog-cli](https://github.com/stevema 2. add a title and body that follows the [conventional-changelog conventions](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md). 3. when you're ready to release to npm: 1. checkout `master`. - 2. run `conventional-recommended-workflow`. + 2. run `standard-version`. 3. `git push --tags; git push origin master; npm publish`. -`conventional-recommended-workflow` does the following: +`standard-version` does the following: -1. bumps the version in package.json +1. bumps the version in package.json (based on your commit history). 2. runs `conventional-changelog` and updates CHANGELOG.md. 3. commits _package.json_ and _CHANGELOG.md_. 4. tags a new release. @@ -26,11 +28,11 @@ the workflow outlined in [conventional-changelog-cli](https://github.com/stevema When you're generating your changelog for the first time, simply do: -`conventional-recommended-workflow --first-release` +`standard-version --first-release` ## Installation -`npm i conventional-recommended-workflow` +`npm i standard-version` ## Automating @@ -39,7 +41,7 @@ Add this to your _package.json_ ```json { "scripts": { - "release": "conventional-recommended-workflow" + "release": "standard-version" } } ``` diff --git a/package.json b/package.json index 05d94d274..59b6edd3b 100644 --- a/package.json +++ b/package.json @@ -1,27 +1,30 @@ { - "name": "conventional-recommended-workflow", + "name": "standard-version", "version": "1.0.0", - "description": "apply the recommended workflow outlined in conventional-changelog-cli.", + "description": "replacement for `npm version` with automatic CHANGELOG generation", "bin": "index.js", - "main": "index.js", "scripts": { "test": "standard" }, "repository": { "type": "git", - "url": "git+https://github.com/bcoe/conventional-recommended-workflow.git" + "url": "git+https://github.com/conventional-changelog/standard-verison.git" }, "keywords": [ "conventional-changelog", "recommended", - "workflow" + "changelog", + "automatic", + "workflow", + "version", + "angular" ], "author": "Ben Coe ", "license": "ISC", "bugs": { - "url": "https://github.com/bcoe/conventional-recommended-workflow/issues" + "url": "https://github.com/conventional-changelog/standard-version/issues" }, - "homepage": "https://github.com/bcoe/conventional-recommended-workflow#readme", + "homepage": "https://github.com/conventional-changelog/standard-version#readme", "dependencies": { "add-stream": "^1.0.0", "chalk": "^1.1.3",