通过 
搜索
搜索chancegarcia / git-toolkit
根据您的提交历史和标签创建变更日志
1.1.1
2021-03-01 03:41 UTC
Requires
- php: >=7.3
- czproject/git-php: ^3
- symfony/console: ^4.4
Requires (Dev)
- php-coveralls/php-coveralls: dev-master
- php-parallel-lint/php-console-highlighter: dev-master
- php-parallel-lint/php-parallel-lint: dev-master
- phpunit/phpunit: ^9
- roave/security-advisories: dev-master
- squizlabs/php_codesniffer: 4.0.x-dev
This package is auto-updated.
Last update: 2024-09-24 21:24:19 UTC
README
develop 分支
此工具包目前只包含一个工具。该工具将根据 git 仓库标签和 git 提交历史为项目创建一个 changelog.md 文件。
安装
composer require --dev chancegarcia/git-toolkit
通用用法
除非在配置文件中指定，否则将使用当前工作目录中找到的仓库。
配置（可选）
可以通过位于
config/chancegarcia_git_toolkit.php
的配置文件设置某些命令参数和选项的默认值。
以下值是可以配置的
project_root：仓库所在的目录project_name：主标题值filename：输出的 markdown 文件名。output_directory：markdown 文件应写入的路径
ChangeLog 命令用法
./vendor/bin/toolkit toolkit:changelog toolkit:changelog
变更日志文件将生成一个具有主标题（可选，通过标题参数设置）为 Projecty McProjectFace 的 markdown 文档。标签名称是副标题，并且在标签之间的提交将打印在副标题之后
虽然您可以通过运行基本命令来生成变更日志，但可能希望传递一个主标题参数。除非您真的想将顶部标题设置为 Projecty McProjectFace（完全不是在批评）。
./vendor/bin/toolkit toolkit:changelog toolkit:changelog "I am not a cat."
准备新的或初始发布标签/编号
如果没有标签存在。副标题将是提交 ID。
为了“创建”一个新的标签，使用 --new-tag=<NEWTAG> 设置新标题并将自上一个标签（如果有）以来的所有最新提交写入到变更日志中。
./vendor/chancegarcia/git-toolkit/bin/toolkit toolkit:changelog "We Love Kittens" --new-tag="1.0.0"