Gathering detailed insights and metrics for conventional-changelog-custom-config-azure
Gathering detailed insights and metrics for conventional-changelog-custom-config-azure
Installations
npm install conventional-changelog-custom-config-azureDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
11.15.0
NPM Version
6.7.0
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
0.4.3
Package Id
conventional-changelog-custom-config-azure@0.4.3
Unpacked Size
32.08 kB
Size
8.40 kB
File Count
18
NPM Version
6.7.0
Node Version
11.15.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
conventional-changelog-custom-config
This preset extends the conventional-changelog-angular preset
Differences to conventional-changelog-angular
- 使用 redmine 或者其他工具管理项目，可以将 GitHub/GitLab 的 issues 地址替换成 bugsUrl 中的地址
- 显示 commit 对应的提交人及邮箱地址
- 使用 emojis
前置插件准备
- commitizen 针对开发者简单的 commit 规范
- cz-conventional-changelog 使用 cz-conventional-changelog 的构建标准
- conventional-changelog-cli conventional-changelog 核心模块
- 这里我使用 release-it 作为发布版本插件，也可以选择 standard-version
1npm i commitizen cz-conventional-changelog conventional-changelog-cli --save-dev 2 3npm install --save-dev release-it
1npm install conventional-changelog-custom-config --save-dev
Configuration
在 package.json 中配置参数
不填配置的话则会按照 angular 的预设模版生成 CHANGELOG
1{ 2 "scripts": { 3 "commit": "git-cz && git push", 4 "release": "release-it", 5 "changelog": "conventional-changelog -p custom-config -i CHANGELOG.md -s -r 0" 6 }, 7 "repository": { 8 "type": "git", 9 "url": "https://github.com/example.git" 10 }, 11 "config": { 12 "commitizen": { 13 "path": "cz-conventional-changelog" 14 } 15 }, 16 "changelog": { 17 "bugsUrl": "https://redmine.example.com/issues/", 18 "emojis": true, 19 "authorName": true, 20 "authorEmail": true 21 } 22}
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
Type: boolean Default: false
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 中生成邮箱
Usage
生成 CHANGELOG 之前得先 commit，记得在 master 主分支上发布版本，再生成 CHANGELOG，流程如下：
1git add . 2 3npm run commit 4 5npm run release 6 7npm run changelog
Examples
Show your support
如果感觉不错，给个 Star 吧~
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2019 zengshunhao.
This project is MIT licensed.
Thanks
Thanks to conventional-changelog
No vulnerabilities found.
No security vulnerabilities found.