From 5dc85d24c53017d3ecae894998b8d9d486b19088 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20B=C3=B6nnemann?= Date: Fri, 28 Aug 2015 10:29:42 +0200 Subject: [PATCH 1/5] chore: make repo "commitizen friendly" Closes #74 --- README.md | 1 + package.json | 12 ++++++++---- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8e9c54e7..92c31165 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Join the chat at https://gitter.im/semantic-release/semantic-release](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/semantic-release/semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard) +[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Dependency Status](https://david-dm.org/semantic-release/semantic-release/badger.svg)](https://david-dm.org/semantic-release/semantic-release/badger) [![devDependency Status](https://david-dm.org/semantic-release/semantic-release/badger/dev-status.svg)](https://david-dm.org/semantic-release/semantic-release/badger#info=devDependencies) diff --git a/package.json b/package.json index c104bc5c..4bbce053 100644 --- a/package.json +++ b/package.json @@ -8,10 +8,6 @@ "bugs": { "url": "https://github.com/semantic-release/semantic-release/issues" }, - "engines": { - "node": ">=0.10", - "npm": ">=2" - }, "config": { "nyc": { "exclude": [ @@ -20,6 +16,9 @@ ] } }, + "czConfig": { + "path": "node_modules/cz-conventional-changelog/" + }, "dependencies": { "@semantic-release/commit-analyzer": "^2.0.0", "@semantic-release/condition-travis": "^4.1.2", @@ -42,6 +41,7 @@ "devDependencies": { "babel": "^5.5.8", "coveralls": "^2.11.2", + "cz-conventional-changelog": "^1.1.0", "mkdirp": "^0.5.1", "nixt": "^0.4.1", "nock": "^2.5.0", @@ -52,6 +52,10 @@ "standard": "^5.0.2", "tap": "^1.3.1" }, + "engines": { + "node": ">=0.10", + "npm": ">=2" + }, "homepage": "https://github.com/semantic-release/semantic-release/tree/next#readme", "keywords": [ "author", From 3251a5146993fe822c8249012c080a0d5f4bd87a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20B=C3=B6nnemann?= Date: Tue, 8 Sep 2015 10:07:39 +0100 Subject: [PATCH 2/5] docs(README): add egghead.io tutorial --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92c31165..f4322e10 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# semantic-release +# :package::rocket: semantic-release -> **fully automated, semver-compliant package publishing** +> **Trust us, this will change your workflow for the better.** + +> – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release) [![Join the chat at https://gitter.im/semantic-release/semantic-release](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/semantic-release/semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) @@ -30,6 +32,21 @@ Out of the box this is just about _commit-messages_, but you can do so much more This removes the immediate connection between human emotions and version numbers, so strictly following the [SemVer](http://semver.org/) spec is not a problem anymore – and that’s ultimately `semantic-release`’s goal. + + + + + + + + +
+ “How to Write a JavaScript Library - Automating Releases with semantic-release” – egghead.io +
+ egghead.io session +
+ A free egghead.io tutorial series on how to write an open source library featuring semantic-release. +
“We fail to follow SemVer – and why it needn’t matter” From 017142e890a627be4a23363cc1990a9cb52974c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20B=C3=B6nnemann?= Date: Wed, 16 Sep 2015 09:25:04 +0200 Subject: [PATCH 3/5] docs(README): smaller fixes and clarifications --- README.md | 50 ++++++++++++++++++++++++++------------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f4322e10..ebf92583 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # :package::rocket: semantic-release +**fully automated package publishing** + > **Trust us, this will change your workflow for the better.** > – [egghead.io](https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-automating-releases-with-semantic-release) @@ -26,8 +28,8 @@ Out of the box this is just about _commit-messages_, but you can do so much more   | Commands | Comment --- | --- | --- -| **manual** | 
npm version major
git push origin master --tags
npm publish
| You **manually decide** what the **next version** is. You have to remember what major, minor and patch means. You have to remember to push both commits and tags. You have to wait for the CI to pass. | -| **semantic-release** | 
git commit -m "fix: <message>"
git push
| You **describe the changes** you’ve made. A new version is automatically published with the correct version number. +| **manual/before** | 
npm version major
git push origin master --tags
npm publish
| You **manually decide** what the **next version** is. You have to remember what major, minor and patch means. You have to remember to push both commits and tags. You have to wait for the CI to pass. | +| **semantic-release/after** | 
git commit -m "fix: <message>"
git push
| You **describe the changes** you’ve made. A new version is automatically published with the correct version number. This removes the immediate connection between human emotions and version numbers, so strictly following the [SemVer](http://semver.org/) spec is not a problem anymore – and that’s ultimately `semantic-release`’s goal. @@ -77,26 +79,9 @@ This removes the immediate connection between human emotions and version numbers Instead of writing [meaningless commit messages](http://whatthecommit.com/), we can take our time to think about the changes in the codebase and write them down. Following formalized conventions it this then possible to generate a helpful changelog and to derive the next semantic version number from them. -_Note: This module ships with the [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) and changelog generator, but you can [define your own](#plugins) style_. - -> ### Commit Message Format - -> Each commit message consists of a **header**, a **body** and a **footer**. The header has a special -format that includes a **type**, a **scope** and a **subject**: - -> ``` -(): - - - -