Giter Club home page Giter Club logo

auto-changelog-starter-kit's Introduction

auto-changelog-starter-kit

This project is a starter kit with auto-changelog dependency configurated. Pre-integrated with ClickUp.

Result

The generated changelog includes three sections if apply.

The line generated: #TASK_ID - Commit Message (#COMMMIT_SHA)

How to use

Available sections

  • fix: - for hotfix, bugfix and others
  • break: - for breaking changes
  • feature: - for features in your app

Commit message

Choose and include section id in your commit message.

Examples:

  • fix: #TASK_ID_CLICKUP Created changelog for app
  • feature: #TASK_ID_CLICKUP Created changelog for app
  • break: #TASK_ID_CLICKUP Created changelog for app
  • fix: Created changelog for app - without task id

I use Jira

No problem, in your package.json change the property auto-changelog for:

"auto-changelog": {
    "commitLimit": false,
    "unreleased": true,
    "issueUrl": "http://jira.user.com.br/browse/{id}",
    "replaceText": {
      "[Ff]eature:": "",
      "[Ff]ix:": "",
      "[Bb]reak:": "",
      "([A-Z]+-\\d+)": "[$1](http://jira.user.com.br/browse/$1) - "
    },
    "includeBranch": [
      "develop",
      "master"
    ]
}

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.