README

此 Bundle 允许您在 Symfony2 应用程序中显示一些 Github 统计数据。有关更多信息，请参阅 https://help.github.com/articles/viewing-contributions。

贡献日历

仓库与贡献

安装

使用 Composer 添加 Bundle

{
    "require" : {
        "digitalkaoz/GithubContributionsBundle" : "~1.0"
    }
}

为缓存添加 "liip/doctrine-cache-bundle": "~1.0" 亦然！

然后更新您的依赖项：php composer.phar update

在您的 AppKernel 中激活 Bundle

public function registerBundles()
{
    $bundles = array(
        // ...
        new digitalkaoz\GithubContributionsBundle\digitalkaozGithubContributionsBundle()
    );

    return $bundles;
}

将路由文件包含在您的 routing.yml 中

digitalkaoz_github_contributions:
    resource: "@digitalkaozGithubContributionsBundle/Resources/config/routing.xml"
    prefix:   /github

配置

完整的配置如下所示

# only needed if you want to cache the github reponses (recommend)
liip_doctrine_cache:
    namespaces:
        github:
            type: file_system

#nothing is required, but its recommended to use an api token and cache the results
digitalkaoz_github_contributions:
    api_token:     your_github_api_token
    cache_service: liip_doctrine_cache.ns.github
    username:      your_github_username
    templates:
        contributions:   digitalkaozGithubContributionsBundle:Contributions:contributions.html.twig
        activity_stream: digitalkaozGithubContributionsBundle:Contributions:activity.html.twig
        user_repos:      digitalkaozGithubContributionsBundle:Contributions:user_repos.html.twig

用法

查看统计信息

• 访问 /github/contributions 查看您贡献的仓库列表
• 访问 /github/repos 查看您自己的仓库列表
• 访问 /github/activity 查看您的贡献日历（类似于 github 的日历）

生成缓存

您的贡献计算可能需要一些时间，因此我构建了一些命令，可以从控制台/计划任务中即时生成缓存。

• 运行 app/console github:contribution-update contribution digitalkaoz 更新 digitalkaoz 的贡献缓存
• 运行 app/console github:contribution-update repos digitalkaoz 更新 digitalkaoz 的仓库缓存
• 运行 app/console github:contribution-update activity digitalkaoz 更新 digitalkaoz 的活动缓存

测试

所有内容都已过测试，并处于 CI 管理下

• https://travis-ci.org/digitalkaoz/GithubContributionsBundle
• https://scrutinizer-ci.com/g/digitalkaoz/GithubContributionsBundle/
• https://insight.sensiolabs.com/projects/a74d75ea-6aa5-4cf9-95dd-db4afbb5b2dc

待办事项

• 其他有用的统计数据？
• 更通用的方法来连接自己的统计收集器？