conventional-changelog-weaveability

A custom preset for conventional changelog and semantic release

Usage no npm install needed!

<script type="module">
  import conventionalChangelogWeaveability from 'https://cdn.skypack.dev/conventional-changelog-weaveability';
</script>

README

Conventional Changelog Weaveabilty

A custom preset for conventional changelog and semantic release

Installing

npm install --save-dev conventional-changelog-weaveability

Additional Setup

Release rules will need to be provided for each type and provided to the commit-analyzer

Docs

Commit Message Format

A commit message currently consists of:

  • header (mandatory): consisting of a type and subject
  • body (optional)
  • footer (optional)
    <type><subject>
    <BLANK LINE>
    <body>
    <BLANK LINE>
    <footer>

Type

The type must prefix your commit message inorder to be detected and used by the commit-analyser and notes-writer

Valid types

  • [FEATURE] - When new functionality has been added to the application
  • [FIX] - For general bug fixes
  • [REFACTOR] - Changeing the implementation of existing functionality
  • [STYLE] - For any changes/fixes to existing styleing
  • [MERGE] - For merge related actions (e.g "resolving conflicts" or "fixing failed merge requests")
  • [CI] - For work relating to Continuious Integration
  • [TEST] - For adding/fixing/refactoring Tests
  • [DOC] - For adding/changing documentation

Subject

The subject should contain a breif precice description of the change

Body

The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer is for additional information like whether the Merge is a breaking change and/or the jira ticket ID

  • Breaking Changes: Add BREAKING CHANGE or BREAKING CHANGES followed by a description of the breaking change
  • Referencing a ticket: #TICKET-1234

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>.