gesdinet / bidla
Bidla 是一个PHP工具,帮助开发者生成变更日志和贡献者文件
Requires
- symfony/console: ~2.6
- symfony/filesystem: ~2.6
- symfony/process: ~2.6
Requires (Dev)
README
Bidla 是一个PHP工具,帮助开发者生成变更日志和贡献者文件。Bidla读取你的版本控制系统日志,并生成一个变更日志/贡献者文件,以便包含在你的仓库中。
安装
本地
下载 bidla.phar
文件并将其存储在您的计算机上的某个位置。
全局(手动)
您可以使用以下命令轻松地从系统中的任何位置访问 bidla.phar
$ wget http://gesdinet.github.io/bidla/download/bidla.phar -O bidla
或使用curl
$ curl http://gesdinet.github.io/bidla/download/bidla.phar -o bidla
$ sudo chmod a+x bidla $ sudo mv bidla /usr/local/bin/bidla
然后,只需运行 bidla
全局(Composer)
要安装 bidla,安装 Composer 并输入以下命令
$ ./composer.phar global require gesdinet/bidla
然后,确保您 ~/.composer/vendor/bin
在您的 PATH
中,您就可以开始了
export PATH="$PATH:$HOME/.composer/vendor/bin"
然后,只需运行 bidla
使用
在这个早期版本中,Bidla 只支持 Git 和 Markdown
这些命令默认将 git、markdown 以及 CHANGELOG.md 或 CONTRIBUTORS.md
- bidla changelog
- bidla contributors
Bidla 变更日志会要求您输入下一个标签发布名称。这是因为在生成变更日志之前进行标签操作时,变更日志文件不会包含在发布中,如果之后 Bidla 无法读取最后一个标签名称。
工作流程是
- 首先提交所有发布更改
- 使用下一个标签名称生成变更日志和贡献者文件,并将其提交
- 标记您的发布
- 将更改推送到远程
可选参数
Bidla 接受三个输入参数
- bidla [vcs] [file] [filename]
###注意
实际上 bidla 只支持 git 和 markdown
更新
本地(实际上不起作用,需要重新下载 .phar)
该 self-update
命令尝试更新 bidla
$ bidla.phar update
全局(手动)(实际上不起作用,需要重新下载 .phar)
您可以通过此命令更新 bidla
$ sudo bidla update
全局(Composer)
您可以通过此命令更新 bidla
$ ./composer.phar global update gesdinet/bidla
示例输出
此项目的 CHANGELOG.md 和 CONTRIBUTORS.md
如何在此项目中协作
请随意打开问题
法律免责声明
本软件根据 MIT 许可证发布,该许可证规定
软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定目的适用性和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任承担责任,无论源于合同、侵权或其他原因,是否与软件或其使用或其他交易有关。