tiagoboeing / auto-changelog-starter-kit

Starter kit of project NodeJS with auto-changelog configurated

auto-changelog-starter-kit

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

• For manual installation or tips:
  • PT-BR
  • English
• Original dependency: auto-changelog

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"
    ]
}