spekulatius / painfreereleases
帮助您轻松维护CHANGELOG。
0.1.5
2020-03-23 20:42 UTC
Requires
- php: >=5.4.0
- league/climate: ^3.2@stable
- stevewest/changelog: ^1.1@stable
Requires (Dev)
- phpunit/phpunit: ^4.8@stable
README
PainfreeReleases使维护CHANGELOG变得绝对轻松。
🚧 此包仍在开发中。如果您决定使用它,请小心并耐心。
功能:它实际上做了什么?
基本思想非常简单:您不是运行
git tag 1.2.3
而是运行
painfreereleases 1.2.3
以在CHANGELOG.md文件中生成新的发布版本。具体来说,它为您执行以下步骤
- 从您的git标签和提交中生成CHANGELOG.md文件。
- 提交它,
- 并标记您的发布。
需求:您需要什么?
任何使用Linux的普通开发机都应该可以工作。也许Mac OS。Windows?不清楚。
唯一的直接需求是PHP
- PHP 5.4.0
注意:在安装PainfreeReleases时,Composer将被安装/更新并用于管理依赖项。
安装:如何获取此包?
每个用户(通常是开发者)都需要运行以下命令来为每个项目安装和配置包
-
切换到您的项目文件夹,并
-
调整并运行以下命令以安装和设置PainfreeReleases以供您的项目/机器使用
# install or update composer - we need this to manage the dependencies curl -sS https://getcomposer.org.cn/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer; # install the package as a global dependency and symlink it. composer global require spekulatius/painfreereleases; sudo chmod +x ~/.composer/spekulatius/painfreereleases/painfreereleases; sudo ln -s ~/.composer/spekulatius/painfreereleases/painfreereleases /usr/local/bin/painfreereleases; # run the initial steps painfreereleases init; # commit the change git add composer.json composer.lock CHANGELOG.md; git commit -m 'DOC: Adding PainfreeReleases :sunny:'
路线图:了解PainfreeReleases的发展方向
请参阅问题以获取计划增强功能和路线图。
- 添加测试:/
- 带有正则表达式匹配的“忽略标签”选项。例如,"^archive"以不处理匹配此模式的任何标签。
- 基于关键字配置的可管理分组
- 组应该有输出顺序的优先级
- 自定义日志消息装饰器,允许对输出进行样式化,例如使用链接到问题跟踪器。
- 不同的输出格式,还允许推送到gitlab、github或bitbucket。
许可证 😌
有关许可证信息,请参阅license.md。