Socket
Socket
Sign inDemoInstall

conventional-changelog-angular

Package Overview
Dependencies
Maintainers
4
Versions
47
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

conventional-changelog-angular

Angular preset for conventional-changelog.


Version published
Weekly downloads
6.2M
decreased by-5.57%
Maintainers
4
Weekly downloads
 
Created

What is conventional-changelog-angular?

The conventional-changelog-angular package is designed to generate changelogs and release notes automatically based on Angular's commit message conventions. It parses commit messages, categorizes them into various types (such as features, fixes, and breaking changes), and generates a changelog file that summarizes the changes in a readable format. This tool is particularly useful for projects that follow semantic versioning and want to automate the process of changelog generation.

What are conventional-changelog-angular's main functionalities?

Generate changelog

This code demonstrates how to generate a changelog using the conventional-changelog-angular preset. It streams the generated changelog content into a file named CHANGELOG.md.

const conventionalChangelog = require('conventional-changelog');
const fs = require('fs');
const changelogStream = conventionalChangelog({ preset: 'angular' });
const outputStream = fs.createWriteStream('CHANGELOG.md');
changelogStream.pipe(outputStream);

Customize changelog generation

This code snippet shows how to customize the changelog generation process. It sets the releaseCount to 0 to generate logs for all releases and transforms 'feat' commit types to be labeled as 'Features' in the changelog.

const conventionalChangelog = require('conventional-changelog');
const fs = require('fs');
const changelogStream = conventionalChangelog({
  preset: 'angular',
  releaseCount: 0, // Generate all releases
  transform: (commit, cb) => {
    if (commit.type === 'feat') {
      commit.type = 'Features';
    }
    cb(null, commit);
  }
});
const outputStream = fs.createWriteStream('CUSTOM_CHANGELOG.md');
changelogStream.pipe(outputStream);

Other packages similar to conventional-changelog-angular

Keywords

FAQs

Package last updated on 03 May 2024

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc