From 6ef503001f56f38410648c9df43a4377e51f19e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20B=C3=B6nnemann?= Date: Sat, 7 Feb 2015 14:21:31 +0100 Subject: [PATCH] docs(readme): typos, clarity and formating --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3a67158d..4d792255 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ `semantic-release` is a toolset to fully automate your package's releases. This will determine not only which version to release, but also when – all without you having to care about it ever again. -This is fully integrated with the `npm` livecycle, so all you have to do is to setup your CI to `npm publish`. +This is fully integrated with the `npm` lifecycle, so all you have to do is to setup your CI to `npm publish`. The goal of this package is to remove humans from version numbers and releases. The [SemVer](http://semver.org/) spec clearly and unambiguously defines when to increase the major, minor or patch part and still we tend to think we're clever when we ignore this, because marketing or something. @@ -19,7 +19,7 @@ The goal of this package is to remove humans from version numbers and releases. Conventions, conventions, conventions. Instead of dumping funny lols into our commit messages, we can take some time to think about what we changed in the codebase and write it down. Following formalized conventions it this then possible to not only generate a meaningful changelog, but to determine the next semantic version to release. Currently the only supported style is the [AngularJS Commit Message Convention](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) style, but feel free to formalize your own style, write a parser for it, and send a PR to this package. -The preferred configuration is the "try to release every push mode". What it does is that everytime a build passes `npm publish` is executed. +The preferred configuration is the "try to release on every push" mode. What it does is that everytime a build passes `npm publish` is executed. ### The `prepublish` step @@ -43,7 +43,9 @@ After `npm` published the new version the `postpublish` step does this: - Create a new [GitHub Release](https://help.github.com/articles/about-releases/) with the changelog as body Note: The GitHub Release automatically creates a tag, too. + Note: This is tied to GitHub, feel free to send PRs for other services. + Note: `semantic-release` works around a limitation in `npm`'s `prepublish` step. Once a version is published it prints an error that you can *safely ignore* [npm/npm#7118](https://github.com/npm/npm/issues/7118). ## How do I set this up? @@ -79,6 +81,7 @@ cache: notifications: email: false env: + # Encrypt this. See notes. global: GH_TOKEN= deploy: provider: npm @@ -86,14 +89,17 @@ deploy: # Very important. Don't forget this one. skip_cleanup: true # Travis currently only supports the old auth key format. - # Do `echo -n "username:passowrd" | base64` to get it. + # Do `echo -n "username:password" | base64` to get it. + # Encrypt this. See notes. api_key: on: branch: master repo: / ``` Note: For once this isn't tied to a specific service, but example configuration is shown for [Travis CI](https://travis-ci.org/). Feel free to contribute configuration of other servers or services. + Note: You should [encrypt](http://docs.travis-ci.com/user/environment-variables/#sts=Secure Variables) your api keys and tokens. + Note: If you have a more sophisticated build with multiple jobs you should have a look at [travis-after-all](https://github.com/dmakhno/travis_after_all), which is also configured for this [package](.travis.yml). MIT License