@inkdpixels/release-notes-generator

Plugin for semantic-release which utilizes the commit guidelines of Neos.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@inkdpixels/release-notes-generator
Minified + gzip package size for @inkdpixels/release-notes-generator in KB

Readme

@inkdpixels/release-notes-generator

Build Status Dependency Status devDependency Status Code Climate Test Coverage

Plugin for semantic-release which utilizes the commit guidelines of Neos.

Installation

npm i -D @inkdpixels/release-notes-generator

Setup & Configuration

Specify the custom release-notes-generator plugin in your projects package.json.

{
  "release": {
    "generateNotes": "@inkdpixels/release-notes-generator"
  }
}

Commit message guidelines

The commit message guidelines, on which this plugin also relies on, are explained over at Inkdpixels/commit-analyzer.

Contributing

We use xo to lint the code, please take care to run npm test before you commit something. If you add or modify methods or the API, please add unit tests as specified in the *.spec.js files.

License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.