Skip to content

Codeinwp/conventional-changelog-simple-preset

Repository files navigation

Simple changelog convention

Conventional changelog preset which triggers release based on the commits on the default branch ( master ).

The type of the release is triggered by the scope.

The release notes are generated based on the commit body.

Examples

  • release: new version will trigger a patch release with no release notes
  • release(minor): new version will trigger a minor release with no release notes
release: new version
 * Fix race condition
 * Improve perfomance issues 
   

will trigger a patch release with

 * Fix race condition
 * Improve perfomance issues 

as release notes.

How to use

In the release file you can add the following configuration

    {
        "branch": "master",
        "plugins": [
          [
            "@semantic-release/commit-analyzer",
            {
              "preset": "simple-preset",
              "releaseRules": "conventional-changelog-simple-preset/release-rules"
            }
          ],
          [
            "@semantic-release/changelog",
            {
              "changelogFile": "CHANGELOG.md"
            }
          ],
          [
            "@semantic-release/release-notes-generator",
            {
              "preset": "simple-preset"
            }
          ]
        ]
    }