From ddac1fdc015a59923353a95c38b1c063759176f9 Mon Sep 17 00:00:00 2001 From: Matthew Taylor Date: Tue, 21 Mar 2017 15:42:32 -0400 Subject: [PATCH 1/2] Configure semantic-release This adds and sets up the `semantic-release` package to use commits and travis to do automated semantic versioning and publishing to npm for scratch-parser. It also adds a readme section about committing, and using `git cz` to handle formatting of commits in a way that is parseable and deployable by `semantic-release`. This setup is based on the existing release setup in `eslint-config-scratch`. --- .travis.yml | 20 +++++++++++++++----- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 15 +++++++++++---- 3 files changed, 75 insertions(+), 9 deletions(-) diff --git a/.travis.yml b/.travis.yml index 00dd791d..62762659 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,18 @@ -language: node_js -node_js: -- "4" -- "stable" sudo: false +language: node_js cache: directories: - - node_modules + - node_modules +notifications: + email: false +node_js: + - '4' +before_install: + - npm i -g npm@^2.0.0 +before_script: + - npm prune +after_success: + - npm run semantic-release +branches: + except: + - /^v\d+\.\d+\.\d+$/ diff --git a/README.md b/README.md index c03d04d5..5a12e07a 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,52 @@ make coverage ```bash make benchmark ``` + +## Committing +This project uses [semantic release](https://github.com/semantic-release/semantic-release) +to ensure version bumps follow semver so that projects using the config don't +break unexpectedly. + +In order to automatically determine the type of version bump necessary, semantic +release expects commit messages to be formatted following +[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md). +``` +(): + + + +