README

composer require --dev dr-bock/git-changelog

Composer包，提供从本地git历史生成composer项目变更日志的服务。

该包仍然是beta版本。并非所有功能都完全支持。直到第一个稳定版本发布，可能会有破坏性更改。使用时请自行承担风险。

免责声明

我知道有很多node-或python脚本可以创建变更日志。但我是PHP开发者，想要一个我能真正掌控的工具。可能除了我没人需要这个包。

安装和用法...

将此包添加到您的composer项目中（理想情况下作为开发依赖）。在部署的项目中，您当然不希望在项目中创建变更日志。

...作为composer命令

将此配置添加到您的项目的composer.json中

 "config": {
    "dr-bock/git-changelog": {
      "commitUrl": "https://your.bitbucket.server/projects/your-project/repos/your-repo/commits/%HASH%",
      "issueUrl": "https://your.jira.server/browse/%ISSUE%",
      "changelogIndexFile": "../CHANGELOG.md",
      "changelogFolder": "../Documentation/Changelog/",
      "issueFormat": "jira"
    }
  },

可能选项

将此脚本添加到您的项目的composer.json中

"scripts": {
    "generate-changelog": [
      "DrBock\\GitChangeLog\\Composer\\GeneratorCommand::generate"
    ]
}

现在可以使用以下命令生成变更日志（在您的composer项目根目录下）

composer generate-changelog -- releaseDate=2019-08-01 releaseName="My cool new Feature Relese" fromTag="release-2019-07-01" 

选项概述

...作为PHP库

/**
 * Samples for Generation of a markdown changelog
 */
 
$generatorOptions = new GeneratorOptions();
$generatorOptions->setProjectName('My Cool Project')
    ->setOutputFormat(MarkdownOutputAdapter::FORMAT) // 'markdown'
    ->setIssueFormat(IssueFormatHelper::JIRA) // 'jira'
    ->setChangelogIndexFile('CHANGELOG.md')
    ->setChangelogFolder('Documentation/Changelog/')
    ->setIssueUrl('https://your.bitbucket.server/projects/your-project/repos/your-repo/commits/%HASH%')
    ->setCommitUrl('https://your.jira.server/browse/%ISSUE%')
    ->setReleaseDate(new \DateTime('2019-08-24'))
    ->setfromTag('release-2019-07-01')
    ->setReleaseName('My cool release');

$generator = new ChangeLogGenerator($generatorOptions);
$generator->generate();

截图

示例变更日志索引

示例变更日志详情