-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Sam Richard
committed
Jun 16, 2016
1 parent
f5b5bd5
commit 2c83a34
Showing
1 changed file
with
22 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,22 @@ | ||
# semantic-release | ||
# Punchcard Semantic Release [![Build Status](https://travis-ci.org/punchcard-cms/semantic-release.svg?branch=master)](https://travis-ci.org/punchcard-cms/semantic-release) [![Coverage Status](https://coveralls.io/repos/github/punchcard-cms/semantic-release/badge.svg?branch=master)](https://coveralls.io/github/punchcard-cms/semantic-release?branch=master) [![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) | ||
|
||
[Semantic Release](https://github.com/semantic-release/semantic-release) analysis and notes generation for use with [Punchcard Commit Messages](https://github.com/punchcard-cms/commit-msg). | ||
|
||
## Usage | ||
|
||
Follow the [Semantic Release](https://github.com/semantic-release/semantic-release) setup instructions, then do the following: | ||
|
||
**Install** | ||
|
||
``` | ||
npm i punchcard-semantic-release --save-dev | ||
``` | ||
|
||
**package.json** | ||
|
||
```json | ||
"release": { | ||
"analyzeCommits": "punchcard-semantic-release/analyze", | ||
"generateNotes": "punchcard-semantic-release/notes" | ||
} | ||
``` |