Giter VIP home page Giter VIP logo

commit-analyzer's Introduction

@inkdpixels/commit-analyzer

Greenkeeper badge Build Status Dependency Status devDependency Status Code Climate Test Coverage

A commit-analyzer plugin for semantic-release which uses the commit guidelines of Neos.

Installation

npm i -D @inkdpixels/commit-analyzer

Setup & Configuration

Specify the custom commit-analyzer plugin in your projects package.json.

{
  "release": {
    "analyzeCommits": "@inkdpixels/commit-analyzer"
  }
}

Commit message guidelines

Every commit message should have a prefix, which is surrounded by square brackets. Below is a list of available prefixes and what kind of release they will trigger once they are in your preferred git release branch.

Prefix Description Release type
!!! Breaking change Major
FEATURE Feature Minor
BUGFIX Bugfix Patch
SECURITY Security change Patch
TASK Other changes No release

More infos regarding the commit message guidelines can be found in the official discuss forum. You may also want to use the generateNotes plugin for this commit style & 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.

commit-analyzer's People

Contributors

greenkeeper[bot] avatar inkdpixels avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

commit-analyzer's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.