Socket
Socket
Sign inDemoInstall

@toptal/commit-analyzer

Package Overview
Dependencies
1
Maintainers
1
Versions
103
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @toptal/commit-analyzer

semantic-release plugin to analyze commits


Version published
Weekly downloads
102
Maintainers
1
Install size
3.85 MB
Created
Weekly downloads
 

Readme

Source

commit-analyzer

A semantic-release plugin that determines the release type by analyzing the commits.

Usage

Include @toptal/commit-analyzer as a semantic-release plugin

{
  "plugins": [
    "@toptal/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/npm",
    "@semantic-release/git"
  ]
}

How it works

Under the hood @toptal/commit-analyzer uses semantic-release/commit-analyzer, but instead of determining the type of release based on the commit subject, it passes the commit body.

This means that if you want to specify in your commit what the release type should be, you can do that, in the second line of your commit, using the conventional commits format. If you don't specify it will default to a patch release.

λ git log
commit 92aba8c113361733fc48f3828294c0b96beaedcc (HEAD -> master)
Author: Toptal
Date:   Tue Nov 3 08:42:02 2020 +0100

    [FX-123] Remove jobs module // Toptal commit format in the subject (first line)
    feat: [FX-123] Remove jobs module // Conventional commit title (second line)
    BREAKING CHANGE: the entire jobs module is deleted and imported as an external dependency // Conventional commit format in the body (third line)

FAQs

Last updated on 17 Feb 2021

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