Skip to content

CaoMeiYouRen/conventional-changelog-cmyr-config

This branch is 53 commits ahead of ITxiaohao/conventional-changelog-custom-config:master.

Folders and files

NameName
Last commit message
Last commit date
Apr 17, 2024
Jul 10, 2019
Dec 21, 2021
Dec 23, 2021
Dec 23, 2021
Jul 10, 2019
Dec 20, 2021
Apr 17, 2024
Jul 10, 2019
Sep 26, 2024
Dec 20, 2021
Dec 23, 2021
Dec 23, 2021
Dec 23, 2021
Dec 23, 2021
Apr 17, 2024
Dec 23, 2021
Mar 14, 2023

Repository files navigation

conventional-changelog-cmyr-config

Version npm downloads Documentation Maintenance License: MIT

本项目 fork 自conventional-changelog-custom-config,在原有基础上添加了更多自定义部分

🏠 主页

前置准备

安装

yarn add conventional-changelog-cmyr-config

配置

在 package.json 中配置参数

不填配置的话则会按照预设模版生成 CHANGELOG

{
  "scripts": {
    "commit": "git-cz && git push",
    "release": "release-it",
    "changelog": "conventional-changelog -p cmyr-config -i CHANGELOG.md -s -r 0"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/example.git"
  },
  "config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
  },
  "changelog": {
    "bugsUrl": "https://redmine.example.com/issues/",
    "authorName": true,
    "authorEmail": true,
    "language": "zh",//本项支持zh和en配置,默认为en,即生成英文changelog,配置后以下settings可省略。(但如果配置了settings会覆盖language的默认配置)
    "settings": {//cmyr-config新增功能,可自定义标题和是否启用某项
      "feat": {
        "title": "✨ 新功能",//定义标题
        "enable": true //定义是否启用该类型,注意feat、fix、perf、revert、refactor这几个类型的commit无法关闭
      },
      "fix": {
        "title": "🐛 Bug 修复"
      },
      "perf": {
        "title": "⚡ 性能优化"
      },
      "revert": {
        "title": "⏪ 回退"
      },
      "refactor": {
        "title": "♻ 代码重构"
      },
      "docs": {
        "title": "📝 文档",
        "enable": false
      },
      "style": {
        "title": "💄 风格",
        "enable": false
      },
      "test": {
        "title": "✅ 测试",
        "enable": false
      },
      "build": {
        "title": "👷‍ 构建",
        "enable": false
      },
      "ci": {
        "title": "🔧 CI 配置",
        "enable": false
      },
      "chore": {
        "title": "🎫 其他更新",
        "enable": false
      }
    }
  }
}

bugsUrl

Type: string Default: false

当你需要将 issues URL 替换成其他 URL 时,使用该参数,例如使用 redmine 管理项目, bugsUrl: 'https://redmine.example.com/issues/'

如果不填 bugsUrl 则会根据 package.json 中的 repository.url 来作为 issues URL

如果你使用了第三方的协作系统(例如 bitbucket), 推荐你使用这个插件 conventional-changelog-angular-bitbucket

emojis types 参考 gitmoji

Commit Type Title Description Emojis
feat Features A new feature
fix Bug Fixes A bug Fix 🐛
docs Documentation Documentation only changes 📝
style Styles Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) 💄
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature ♻️
perf Performance Improvements A code change that improves performance ⚡️
test Tests Adding missing tests or correcting existing tests
build Build Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) 👷
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) 🔧
chore Chores Other changes that don't modify src or test files 🎫
revert Reverts Reverts a previous commit

authorName

Type: boolean Default: false

在 CHANGELOG 中生成用户名

authorEmail

Type: boolean Default: false

在 CHANGELOG 中生成邮箱

使用

生成 CHANGELOG 之前得 commit,记得在 master 主分支上发布版本,再生成 CHANGELOG,流程如下:

git add .

npm run commit

npm run release

npm run changelog

作者

👤 CaoMeiYouRen

🤝贡献

欢迎 Contributions, issues and feature!
如有问题请查看 issues page. 您还可以查看contributing guide.

支持

如果觉得这个项目有用的话请给一颗⭐️,非常感谢

📝 License

Copyright © 2020 CaoMeiYouRen.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

Packages

No packages published

Languages

  • JavaScript 91.5%
  • Handlebars 8.5%