Giter VIP home page Giter VIP logo

conventional-changelog-metahub's Introduction

conventional-changelog-metahub

conventional-changelog preset built from a list of conventional commit types (similar to conventional-commit-types). Also provides release rules configuration for sr-commit-analyzer.

Travis Codecov Greenkeeper badge

Commit types originally from:

Install

npm install --save-dev conventional-changelog-metahub

Configuration for sr-commit-analyzer

npm install --save-dev sr-commit-analyzer
{
  "release": {
    "analyzeCommits": {
      "path": "sr-commit-analyzer",
      "preset": "metahub",
      "releaseRules": "conventional-changelog-metahub/release-rules"
    }
  }
}

Configuration for sr-release-notes-generator

npm install --save-dev sr-release-notes-generator
{
  "release": {
    "generateNotes": {
      "path": "sr-release-notes-generator",
      "preset": "metahub"
    }
  }
}

Use with conventional-changelog

npm install --save-dev conventional-changelog
import conventionalChangelog from 'conventional-changelog';

const config = require('conventional-changelog-metahub');
conventionalChangelog({config}).pipe(process.stdout);

Commit types

Commit Type Title Description Emoji Release Include in changelog
feat Features A new feature โœจ minor true
fix Bug Fixes A bug Fix ๐Ÿ› patch true
docs Documentation Documentation only changes ๐Ÿ“š patch if scope is readme true
style Styles Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) ๐Ÿ’Ž - true
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature ๐Ÿ“ฆ - true
perf Performance Improvements A code change that improves performance ๐Ÿš€ patch true
test Tests Adding missing tests or correcting existing tests ๐Ÿšจ - true
build Builds Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) ๐Ÿ›  patch true
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) โš™๏ธ - true
chore Chores Other changes that don't modify src or test files โ™ป๏ธ - true
revert Reverts Reverts a previous commit ๐Ÿ—‘ - true

Commit aliases

Aliases allow to have additional commit types (in a tool like commitizen for example) that can be formatted to follow AngularJS Commit Message Conventions.

For example the commitizen CLI can present the choice initial and the final commit message will be 'feat: Initial commit ๐ŸŽ‰'

Commit Type Maps to Title Description Emoji
initial feat Initial Initial commit ๐ŸŽ‰
dependencies fix Dependencies Update dependencies โฌ†๏ธ
peerDependencies fix Peer dependencies Update peer dependencies โฌ†๏ธ
devDependencies chore Dev dependencies Update development dependencies โฌ†๏ธ
metadata fix Metadata Update metadata (package.json) ๐Ÿ“ฆ

Related

conventional-changelog-metahub's People

Contributors

greenkeeper[bot] avatar greenkeeperio-bot avatar pvdlg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.