Socket
Socket
Sign inDemoInstall

conventional-changelog-revel-commit

Package Overview
Dependencies
6
Maintainers
3
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    conventional-changelog-revel-commit

Revel's conventional-changelog revel-commit preset


Version published
Weekly downloads
0
Maintainers
3
Created
Weekly downloads
 

Readme

Source

Build Status Coverage Status

conventionalcommits.org convention

A concrete implementation of the specification described at conventionalcommits.org for automated CHANGELOG generation and version management. Some modifications have been made as seen in revel-commit.

Indirect Usage (as preset)

Use the Conventional Changelog CLI Quick Start with the -p revel-commit option.

Direct Usage (as a base preset so you can customize it)

If you want to use this package directly and pass options, you can use the Conventional Changelog CLI Quick Start and with the --config or -n parameter, pass a js config that looks like this

'use strict'
const config = require('conventional-changelog-conventionalcommits')

module.exports = config({
    "issuePrefixes": ["TEST-"],
    "issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
})

or json config like that:

{
    "options": {
        "preset": {
            "name": "revel-commit",
            "issuePrefixes": ["TEST-"],
            "issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
        }
    }
}

This last json config way passes the preset object to the conventional-changelog-preset-loader package, that in turn, passes this same preset object as the config for the conventional-changelog-conventionalcommits.

See conventional-changelog-config-spec for available configuration options.

Keywords

FAQs

Last updated on 10 May 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc