alessandro_podo / git-changelog-generator
可以根据Git Commit的元数据生成具有读取权限的Changelog
0.0.5
2024-09-16 20:12 UTC
Requires
- php: >=8.2
- symfony/clock: ^7.1
- symfony/console: ^7.1
- symfony/framework-bundle: ^7.1
- symfony/process: ^7.1
- symfony/security-bundle: ^7.1
- symfony/twig-bundle: ^7.1
- symfony/yaml: ^7.1
- webmozart/assert: ^1.11
Requires (Dev)
- ekino/phpstan-banned-code: ^2.0
- friendsofphp/php-cs-fixer: ^3.62
- phpstan/extension-installer: ^1.4
- phpstan/phpstan: ^1.11
- phpstan/phpstan-symfony: ^1.4
- phpunit/phpunit: ^11.3
- rector/rector: ^1.2
- symfony/dom-crawler: ^7.1
- symplify/phpstan-rules: ^13.0
- tomasvotruba/cognitive-complexity: ^0.2.3
This package is auto-updated.
Last update: 2024-09-16 20:18:18 UTC
README
安装
步骤 1:下载Bundle
打开命令行控制台,进入您的项目目录并执行以下命令以下载此Bundle的最新稳定版本
composer require alessandro_podo/git-changelog-generator
步骤 2:启用Bundle
然后,通过将其添加到项目config/bundles.php
文件中注册的Bundle列表中来启用Bundle
// config/bundles.php return [ // ... AlessandroPodo\GitChangelogGenerator\GitChangelogGenerator::class => ['all' => true], ];
步骤 3:创建配置
# config/packages/git_changelog_generator.yaml git_changelog_generator: validateMapping: ROLE_*': - <visibility footer> scopes: - ...
步骤 4:创建控制器
控制器
use AlessandroPodo\GitChangelogGenerator\Service\Changelog\Changelog; #[Route(path: '/changelog')] public function change( Changelog $changelog, ): Response { return $this->render('changelog/index.html.twig', ['content'=> $changelog->render()]); }
Twig模板
# extend base Template {% block body %} {{ content|raw }} {% endblock %}
设置
# Dateiname kann unten den Optionen angepasst werden. Default ist: plannedChangesFile.yml composer: - title: Composer description: Composer ready: false type: refactor
这将列出计划中的更改。如果文件为空,将显示没有计划更改。如果文件不存在,则不会显示任何内容
提交消息
- 如果页脚包含
title:
,则使用此内容 - 如果页脚包含
description:
,则使用此内容 - 如果页脚包含
visibility:
/v:
,则使用此内容,否则使用ConfigFile中的默认值