README.md

@inkdpixels/commit-analyzer

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.