symfony2.rst

Install Gitonomy GitBundle in a Symfony2 application

To start using this bundle, first, add the bundle to your composer.json:

{
    "require": {
        "gitonomy/twig-bundle": "dev-master"
    }
}

Then, add a line to your AppKernel:

class AppKernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Gitonomy\Bundle\GitBundle()
        );
    }
}

In your config.yml file, you need to enable the twig extension:

gitonomy_twig:
    twig_extension:
        enabled: true

Configure routing

For links, this extension will rely on a "default" routing implementation, expecting some given routes with given arguments to be defined.

If you want to parameter those routes, you can configure it:

# Gitonomy Twig
gitonomy_twig:
    twig_extension:
        # ...
        routes_names:
            commit:               project_commit
            branch:               project_history
            tag:                  project_history
            tree:                 project_tree
        routes_args:
            commit_repository:    slug
            commit_hash:          hash
            branch_repository:    slug
            branch_name:          branch
            tag_repository:       slug
            tag_name:             branch
            tree_repository:      slug
            tree_revision:        revision
            tree_path:            path

Inject git assets

To make blocks look awesome, we used CSS and Javascript to make your experience better. Since integration of assets really depend of how your application manage them, this bundle won't try to load them automatically.

If you are using Assetic:

{% stylesheets
    "bundles/gitonomytwig/css/all.css"
%}
    <link rel="stylesheet" href="{{ asset(asset_url) }}" />
{% endstylesheets %}

{% javascripts
    "bundles/gitonomytwig/js/log.js"
    "bundles/gitonomytwig/js/commit.js"
%}
    <script type="text/javascript" src="{{ asset(asset_url) }}"></script>
{% endjavascripts %}