“搜索更改”对话框
chachacha的Python项目详细描述
恰恰
更改chacha日志。这是一个可以用来保持变更日志整洁的工具, {a4}后面的^ 规范是目前实现最多的插件。在
安装
从releases page获取最新副本 把它放在你可以调用的地方。在
或者,您可以选择安装Python包并处理$PATH
配置。在
$ pip install chachacha ...
快速启动
初始化新的更改日志,然后添加一些更改:
^{pr2}$子命令从Keep a Changelog建模 规格:
chachacha --help Usage: chachacha [OPTIONS] COMMAND [ARGS]... Options: --filename TEXT changelog filename --driver TEXT changelog format driver --help Show this message and exit. Commands: init initialize a new file config configure changelog options release release a version added add an "added" entry changed add a "changed" entry deprecated add a "deprecated" entry fixed add a "fixed" entry removed add a "removed" entry security add a "security" entry
因此您可以add,change,deprecate,fix,remove和security 宣布你的改变。在
KAC格式插件驱动程序很大程度上依赖于Colin Bounuar的 keepachangelog library。在
发布版本很简单:
chachacha release --help Usage: main.py release [OPTIONS][SPEC] Update the changelog to release version SPEC. SPEC should either be the version number to release or the strings "major", "minor" or "patch". Options: --help Show this message and exit.
规范遵循Semantic Versioning 多亏了pythonsemver library。在
配置
从0.1.3开始,Chachacha直接支持一个小型配置系统 通过一个黑客的降价链接语法嵌入到文件中。这考虑到 许多功能,如生成比较历史记录:
chachacha init chachacha config git_provider GH chachacha config repo_name aogier/chachacha chachacha config tag_template 'v{t}' chachacha added one feature chachacha added another feature chachacha release chachacha security hole chachacha added capability cat CHANGELOG.md [...] - another feature [Unreleased]: https://github.com/aogier/chachacha/compare/v0.0.1...HEAD [0.0.1]: https://github.com/aogier/chachacha/releases/tag/v0.0.1 [//]: # (C3-1-DKAC-GGH-Raogier/chachacha-Tv{t})
配置系统密钥包括:
git_provider
:git repo提供程序驱动程序(支持:GH
github.com网站)在repo_name
:repo名称+repo的名称空间tag_template
:一个标记模板,它用标记名映射发布版本。 变量t
将使用版本号展开。在
示例
启动变更日志,添加条目,然后释放
chachacha init # quoting is supported chachacha added "this is a new feature I'm excited about" chachacha added this is also good chachacha deprecated this is no longer valid
文件现在是:
cat CHANGELOG.md # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased]### Added - this is a new feature I'm excited about - this is also good ### Deprecated - this is no longer valid [//]: # (C3-1-DKAC)
现在释放它:
chachacha release chachacha added new version added item
文件现在是:
cat CHANGELOG.md
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- new version added item
## [0.0.1] - 2020-02-26
### Added
- this is a new feature I'm excited about
- this is also good
### Deprecated
- this is no longer valid
[//]: # (C3-1-DKAC)
- 项目
标签: