conventional-changelog-angular vs standard-version vs conventional-changelog-cli
Versioning and Changelog Management Comparison
1 Year
conventional-changelog-angularstandard-versionconventional-changelog-cliSimilar Packages:
What's Versioning and Changelog Management?

These npm packages facilitate the generation of changelogs and versioning for projects, particularly those following semantic versioning. They help automate the process of documenting changes in a project, ensuring that developers and users are aware of what has changed between releases. This is crucial for maintaining clear communication in collaborative environments and for managing project updates effectively. By using these tools, developers can streamline their release processes, improve project documentation, and enhance the overall quality of their software releases.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
conventional-changelog-angular8,199,0348,05113.1 kB242a year agoISC
standard-version511,9367,779136 kB309-ISC
conventional-changelog-cli366,6018,05114.6 kB242a year agoMIT
Feature Comparison: conventional-changelog-angular vs standard-version vs conventional-changelog-cli

Changelog Generation

  • conventional-changelog-angular:

    This package generates changelogs specifically formatted for Angular projects, adhering to its commit message conventions. It ensures that the changelog is structured and consistent, making it easier for developers to understand the changes made in each release.

  • standard-version:

    Standard Version automates the process of versioning and changelog generation based on conventional commit messages. It simplifies the release process by automatically bumping the version number and generating a changelog, making it easy to maintain project documentation.

  • conventional-changelog-cli:

    This CLI tool generates changelogs based on various commit message formats, allowing for customization and flexibility. It can parse commit messages and create a comprehensive changelog that reflects the project's history, making it suitable for diverse projects.

Customization

  • conventional-changelog-angular:

    Customization options are limited to Angular's conventions, which may not suit all projects. However, it provides a consistent output that aligns with Angular's standards, which can be beneficial for teams familiar with this framework.

  • standard-version:

    Offers some level of customization, but primarily focuses on automating versioning and changelog generation without requiring extensive configuration, making it user-friendly.

  • conventional-changelog-cli:

    Highly customizable, this package allows developers to define their own commit message conventions and changelog formats, making it adaptable to various project needs and styles.

Ease of Use

  • conventional-changelog-angular:

    While it provides a structured approach, it may require a learning curve for those unfamiliar with Angular's conventions. Once understood, it simplifies the changelog generation process for Angular projects.

  • standard-version:

    Designed for simplicity, this package automates many processes, making it easy for developers to manage versioning and changelogs without deep technical knowledge.

  • conventional-changelog-cli:

    This CLI tool is straightforward to use, especially for developers familiar with command-line interfaces. It requires minimal setup and can be integrated easily into existing workflows.

Integration

  • conventional-changelog-angular:

    Integrates well with Angular projects and tools that follow Angular's conventions, making it a natural choice for Angular developers.

  • standard-version:

    Easily integrates into CI/CD pipelines and can be used alongside other tools to automate the release process, enhancing workflow efficiency.

  • conventional-changelog-cli:

    Can be integrated into any JavaScript project, regardless of framework, making it a versatile choice for teams using various technologies.

Community and Support

  • conventional-changelog-angular:

    Backed by the Angular community, it has good support and documentation, making it reliable for Angular developers.

  • standard-version:

    Widely used in the community, it has a wealth of resources and examples available, making it easier for developers to implement and troubleshoot.

  • conventional-changelog-cli:

    Has a broad user base and extensive documentation, ensuring that developers can find support and resources easily.

How to Choose: conventional-changelog-angular vs standard-version vs conventional-changelog-cli
  • conventional-changelog-angular:

    Select this package if your project follows the Angular commit message conventions and you want to generate changelogs that align with Angular's style. It is particularly useful for Angular-based projects that require a standardized approach to versioning and changelog generation.

  • standard-version:

    Opt for this package if you want a simple and automated way to manage versioning and changelogs without needing to adhere to specific commit message formats. It is ideal for projects that prefer a straightforward approach to versioning and changelog generation, allowing for easy releases based on conventional commits.

  • conventional-changelog-cli:

    Choose this package if you need a versatile command-line tool that can generate changelogs based on various commit message conventions. It is suitable for projects that may not adhere strictly to Angular's conventions and require flexibility in changelog generation.

README for conventional-changelog-angular

conventional-changelog-angular

ESM-only package NPM version Node version Dependencies status Install size Build status Coverage status

conventional-changelog angular preset.

Issues with the convention itself should be reported on the Angular issue tracker.

Install

# yarn
yarn add -D conventional-changelog-angular
# pnpm
pnpm add -D conventional-changelog-angular
# npm
npm i -D conventional-changelog-angular

Angular Convention

Angular's commit message guidelines.

Examples

Appears under "Features" header, pencil subheader:

feat(pencil): add 'graphiteWidth' option

Appears under "Bug Fixes" header, graphite subheader, with a link to issue #28:

fix(graphite): stop graphite breaking when width < 0.1

Closes #28

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:

perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.

The following commit and commit 667ecc1 do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Commit Message Format

A commit message consists of a header, body and footer. The header has a type, scope and subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

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>., where the hash is the SHA of the commit being reverted.

Type

If the prefix is feat, fix or perf, it will appear in the changelog. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.

Other prefixes are up to your discretion. Suggested prefixes are build, ci, docs ,style, refactor, and test for non-changelog related tasks.

Details regarding these types can be found in the official Angular Contributing Guidelines.

Scope

The scope could be anything specifying place of the commit change. For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this document.