README

ChangeLog Writer 是一个允许您自动为您项目生成 Changelog 文件的工具。

环境要求

ChangeLog Writer 需要 PHP 版本 7.3.0 或更高版本。

在应用中

版本控制 GIT 的 Develop 和 Master 分支，根目录下的 CHANGELOG.md 文件

安装

要开始使用 ChangeLog Writer，请按照以下步骤操作

1. 使用 Composer 安装包

   composer global require hiddenpathz/changelog-writer

2. 添加系统链接

   sudo ln -s ~/.config/composer/vendor/hiddenpathz/changelog-writer/src/bin /usr/bin/changeloger

3. Changeloger 准备就绪。在您的项目文件夹中，只需调用您创建的链接即可。

为工作准备项目

在您的 ENV 文件中添加

• 变量，包含指向您仓库的链接，到标签号

• 分支前缀（可选，取决于规则）

  REPOSITORY_LINK=https://gitlab.some.ru/your.repo.ru//-/tags/
  BRANCH_PREFIX=MYPROJECT

您的运行 ChangeLog Writer 的命令行如下所示

changeloger

changeloger https://gitlab.some.ru/your.repo.ru//-/tags/

如果指定了路径属性，将使用该路径在文件中。

使用方法

• 启动时，您将自动切换到 Develop 分支。

• 从它创建的分支类型为： "hotfix/MYPROJECT-26042023-assign-to-changelog"（如果 env 中指定了前缀） "hotfix/26042023-assign-to-changelog"（如果 env 中未指定前缀）

• 接下来将输出当前应用程序的版本

  Текущая версия приложения: 1.24.5
  Какую версию нужно поднять?
  1 - major (*.0.0)
  2 - minor (0.*.0)
  3 - fix   (0.0.*)

• 选择下一个应用程序版本后，脚本将输出所有符合命名规则的提交。

请确保您的提交包含消息中的关键字，以便它们在 Changelog 文件中显示。

• 符合 changelog 的提交示例。

  refactor: Rewrite order method

结果示例

# История изменений

## [ [1.1.0](https://gitlab.some.ru/your.repo.ru//-/tags/1.1.0) ] - 01.01.2023
- Реализовано:
  - Установлена версия РНР до 8.2
  - Добавлен пакет Redis
- Изменено:
  - Переписан метод получения заказа

工作结束

• 当脚本完成工作并文件填充后，它将提示创建提交
• 如果按 Y，则创建提交并将分支合并到仓库中，同时本地删除
• 如果按 N，则需要手动执行这些操作
• 接下来只需转到仓库，创建 MR 将更改转移到 develop
• 然后同样通过 MR 将更改转移到 master

许可证

ChangeLog Writer 根据 MIT 许可证发布。详细信息可以在项目的根目录中的 LICENSE 文件中找到。