README

介绍

这个 Symfony 插件提供了一个命令，根据 Git 提交历史自动生成 Sprint 审查演示的幻灯片。

安装

步骤 1：Composer require

$ php composer.phar require "thormeier/breadcrumb-bundle"

步骤 2：在内核中启用插件

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Thormeier\SlidesGeneratorBundle\ThormeierSlidesGeneratorBundle(),
        // ...
    );
}

配置

在 config.yml 中启用插件

# config.yml
thormeier_slides_generator:
    identifier_pattern: "/(TICKET [0-9]+)/"

请注意，identifier_pattern 是必需的，没有默认值。更多内容请参阅以下内容。

完整的配置如下

# config.yml
thormeier_slides_generator:
    identifier_pattern:   ~ # Required
    keyword_add:          ':slides'
    repository_service:   thormeier_slides_generator.repository.git
    renderer_service:     thormeier_slides_generator.renderer.markdown
    generator_service:    thormeier_slides_generator.generator

使用方法

如果您想将消息添加到幻灯片中，请在 git 提交消息中添加 :slides。执行 Symfony 命令 slides:generate 在控制台中生成幻灯片的输出。

更改关键字以添加提交到幻灯片

如果您想在提交消息中使用不同的关键字（例如 :slides）来指示将提交添加到幻灯片，您可以这样配置

# config.yml
thormeier_slides_generator:
    keyword_add: "add this to the slides"

仓库将搜索提交消息中此字符串的实例，并将提交添加为幻灯片。

使用不同的模式进行票务名称

通过使用正则表达式 "/(TICKET [0-9]+)/"，将类似 TICKET 1234 的第一次匹配发生用作幻灯片标题/标识符。具有相同标识符且包含配置的幻灯片关键字的多个提交将合并为一个幻灯片。

您可以如此配置 identifier_pattern

# config.yml
thormeier_slides_generator:
    identifier_pattern: "/(TICKET [0-9]+)/"

任何有效的正则表达式都可以。

替换 git 存储

要替换默认的 git 存储，定义一个实现 Thormeier\SlidesGeneratorBundle\Repository\SlideRepositoryInterface 接口的服务。然后，您可以在配置中将其配置为您所需的存储库服务。

# config.yml
thormeier_slides_generator:
    repository_service: "acme.slides_renderer" # Replace `acme.slides_repository` with your service ID

例如，您可以使用数据库作为存储或实现其他任何内容。

替换 markdown 渲染器

要替换默认的 markdown 渲染器，定义一个实现 Thormeier\SlidesGeneratorBundle\Renderer\RendererInterface 接口的服务。然后，您可以在配置中将其配置为您所需的渲染服务。

# config.yml
thormeier_slides_generator:
    renderer_service: "acme.slides_renderer" # Replace `acme.slides_renderer` with your service ID

例如，您可以创建一个 Twig 渲染器或实现其他任何内容。

替换整个生成器

要替换默认生成器，定义一个实现 Thormeier\SlidesGeneratorBundle\Generator\SlidesGeneratorInterface 接口的服务。然后，您可以在配置中将其配置为您所需的渲染服务。

# config.yml
thormeier_slides_generator:
    generator_service: "acme.slides_generator" # Replace `acme.slides_generator` with your service ID