README

那么，这个小玩意儿是做什么的？

它为您添加了与项目持续集成相关的额外部分到Symfony Web Debug Toolbar

通过悬停在工具栏中的每个项上，您可以查看每个CI服务为您的项目的徽章

目前，以下收集器是内置的

Travis : 显示您Travis测试的最新结果徽章
Scrutinizer : 显示您Scrutinizer测试的最新结果（代码质量和覆盖率）
... 更多即将到来！如果您有自己的想法，请发送它们（创建一个带有标签 'enhancement' 的新问题）！

要求

您的项目使用Symfony（还能是什么？）
您已在GitHub上托管了您的项目，并且您正在对项目的克隆版本进行工作（根目录中有 .git 目录）
可选：您已经将Travis CI或Scrutinizer CI的服务钩子（或两者）连接到您的GitHub仓库，以便您无需在每次修改时手动运行测试
必选：您为自己买了一个美味的巧克力蛋糕来庆祝看到所有您喜欢的工具汇集在一起 :)！

如果您在GitHub上托管了您的Symfony项目，但尚未连接到任何服务；有很多指南可以帮助您完成此操作，而且这真的非常简单，所以请尝试一下！

安装

在您的 composer.json 中添加以下内容

"require-dev": {
    [...]
    "cleentfaar/ci-bundle" : "dev-master"
},

然后运行 php composer.phar update cleentfaar/ci-bundle

在您的 AppKernel 中注册此包

大多数情况下，我们只需要在 dev 环境中激活此包

// app/AppKernel.php
[...]
if (in_array($this->getEnvironment(), array('dev', 'test'))) {
    [...]
    $bundles[] = new Cleentfaar\CIBundle\CleentfaarCIBundle();
}

激活您想要使用的收集器

收集器可以独立使用，并且可以通过以下方式通过配置启用/禁用。由于您应该主要通过开发环境使用此包，我建议您将它们添加到 config_dev.yml

快速配置

由于大多数配置都有合理的默认值，您只需要以下配置即可使用所有收集器

# app/config/config_dev.yml
cleentfaar_ci:
    travis: true
    scrutinizer:
        shields:
            quality:
                hash: YOUR_QUALITY_BADGE_HASH_HERE
            coverage:
                hash: YOUR_COVERAGE_BADGE_HASH_HERE

关于哈希

如上图所示，显示Scrutinizer徽章需要哈希。

要获取哈希，请简单地登录到您的Scrutinizer仪表板，然后找到右侧显示的徽章示例。

如果您点击它旁边的信息图标，您将获得每个徽章的源代码。在图像的URL末尾是您需要在本配置中输入的哈希值。

另一个建议是，您使用参数在您的app/config/config_dev.yml文件中填写实际值。这样做的原因是，如果您在一个有多个开发者的项目中工作，您可能随时在多个分支上工作。由于徽章是在同一个项目上的团队，即使公开这个数字可能没有危险；

下面是一个示例

# app/config/config_dev.yml
cleentfaar_ci:
    travis: true
    scrutinizer:
        shields:
            quality:
                hash: %my_app.scrutinizer.quality_hash%
            coverage:
                hash: %my_app.scrutinizer.coverage_hash%

然后，在您的parameters.yml文件中（应该是非版本化的，这有助于）

# app/config/parameters.yml
parameters:
    ...
    my_app.scrutinizer.quality_hash: 123456789abcdefgh
    my_app.scrutinizer.coverage_hash: 123456789abcdefgh
    ...

显然，在最后一个示例中，您应该用来自您的Scrutinizer仪表板的值替换这些值

完整配置示例

以下您可以看到当前配置选项的完整参考。请注意，随着功能的增加，将提供更多选项。

cleentfaar_ci:
    travis:
        enabled:            false
        shields:
            build:
                enabled:    true
    scrutinizer:
        enabled:            false
        shields:
            quality:
                hash: YOUR_QUALITY_BADGE_HASH_HERE
            coverage:
                hash: YOUR_COVERAGE_BADGE_HASH_HERE

即将推出

调试页面中每个服务的详细面板视图，直接通过使用API和图表来指示测试结果
更多的配置选项，特别是为了与不同的API进行身份验证以获得更详细的结果
您的想法在这里！

总结

在不久的将来，我希望将这些服务整合到实际使用的详细页面（您在点击其他工具栏项时看到的页面）的面板中。

我正在考虑使用为Travis和Scrutinizer制作的API来显示一些快速图表和一些测试结果，所有这些都可以直接在您最喜欢的工具栏下访问！

cleentfaar / ci-bundle

维护者

详细信息