Skip to content

Commit

Permalink
chore: rename plugin and move to semantic-release org
Browse files Browse the repository at this point in the history
BREAKING CHANGE: plugin is now the default one used by `semantic-release`
  • Loading branch information
pvdlg committed Sep 17, 2017
1 parent 7f92489 commit 04f0e71
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 30 deletions.
35 changes: 9 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,29 @@
# **sr-release-notes-generator**
# **release-notes-generator**

Customizable release-notes-generator plugin for [semantic-release](https://github.com/semantic-release/semantic-release) based on [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)

[![npm](https://img.shields.io/npm/v/sr-release-notes-generator.svg)](https://www.npmjs.com/package/sr-release-notes-generator)
[![npm](https://img.shields.io/npm/dt/sr-release-notes-generator.svg)](https://www.npmjs.com/package/sr-release-notes-generator)
[![Greenkeeper badge](https://badges.greenkeeper.io/vanduynslagerp/sr-release-notes-generator.svg)](https://greenkeeper.io/)
[![license](https://img.shields.io/github/license/vanduynslagerp/sr-release-notes-generator.svg)](https://github.com/vanduynslagerp/sr-release-notes-generator/blob/master/LICENSE)
[![npm](https://img.shields.io/npm/v/@semantic-release/release-notes-generator.svg)](https://www.npmjs.com/package/@semantic-release/release-notes-generator)
[![npm](https://img.shields.io/npm/dt/@semantic-release/release-notes-generator.svg)](https://www.npmjs.com/package/@semantic-release/release-notes-generator)
[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/release-notes-generator.svg)](https://greenkeeper.io/)
[![license](https://img.shields.io/github/license/semantic-release/release-notes-generator.svg)](https://github.com/semantic-release/release-notes-generator/blob/master/LICENSE)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![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)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Travis](https://img.shields.io/travis/vanduynslagerp/sr-release-notes-generator.svg)](https://travis-ci.org/vanduynslagerp/sr-release-notes-generator)
[![Code Climate](https://img.shields.io/codeclimate/github/vanduynslagerp/sr-release-notes-generator.svg)](https://codeclimate.com/github/vanduynslagerp/sr-release-notes-generator)
[![Codecov](https://img.shields.io/codecov/c/github/vanduynslagerp/sr-release-notes-generator.svg)](https://codecov.io/gh/vanduynslagerp/sr-release-notes-generator)

## Install
```bash
npm install --save-dev semantic-release sr-release-notes-generator
```

Set the `generateNotes` plugin for `semantic-release` in `package.json`. See [semantic-release plugins](https://github.com/semantic-release/semantic-release#plugins).
```json
{
"release": {
"generateNotes": "sr-release-notes-generator"
}
}
```
[![Travis](https://img.shields.io/travis/semantic-release/release-notes-generator.svg)](https://travis-ci.org/semantic-release/release-notes-generator)
[![Code Climate](https://img.shields.io/codeclimate/github/semantic-release/release-notes-generator.svg)](https://codeclimate.com/github/semantic-release/release-notes-generator)
[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/release-notes-generator.svg)](https://codecov.io/gh/semantic-release/release-notes-generator)

## Options

By default `sr-release-notes-generator` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md).
By default `release-notes-generator` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md).

Additionnal options can be set within the plugin definition in `package.json` to use a different commit format and to customize it:

```json
{
"release": {
"generateNotes": {
"path": "sr-release-notes-generator",
"preset": "angular",
"parserOpts": {
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
Expand Down Expand Up @@ -70,7 +55,6 @@ The following example uses [Angular convention](https://github.com/conventional-
{
"release": {
"generateNotes": {
"path": "sr-release-notes-generator",
"preset": "angular",
"parserOpts": {
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"],
Expand All @@ -91,7 +75,6 @@ The following example uses [Angular convention](https://github.com/conventional-
{
"release": {
"generateNotes": {
"path": "sr-release-notes-generator",
"preset": "angular",
"writerOpts": {
"commitsSort": ["subject", "scope"],
Expand Down
13 changes: 9 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
{
"name": "sr-release-notes-generator",
"name": "@semantic-release/release-notes-generator",
"description": "Customizable release-notes-generator plugin for semantic-release",
"version": "0.0.0-development",
"author": "Pierre Vanduynslager",
"authors": [
"Stephan Bönnemann <[email protected]> (http://boennemann.me)",
"Gregor Martynus (https://twitter.com/gr2m)",
"Pierre Vanduynslager (https://twitter.com/PierreAtHome)"
],
"bugs": {
"url": "https://github.com/vanduynslagerp/sr-release-notes-generator/issues"
"url": "https://github.com/semantic-release/release-notes-generator/issues"
},
"config": {
"commitizen": {
Expand Down Expand Up @@ -76,7 +81,7 @@
"files": [
"lib"
],
"homepage": "https://github.com/vanduynslagerp/sr-release-notes-generator#readme",
"homepage": "https://github.com/semantic-release/release-notes-generator#readme",
"keywords": [
"changelog",
"conventional-changelog",
Expand Down Expand Up @@ -123,7 +128,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/vanduynslagerp/sr-release-notes-generator.git"
"url": "https://github.com/semantic-release/release-notes-generator.git"
},
"scripts": {
"clean": "rimraf coverage && rimraf .nyc_output",
Expand Down

0 comments on commit 04f0e71

Please sign in to comment.