kendrick-k / symfony-debug-toolbar-git

Get the latest Git commit information into Symfony debug toolbar

Symfony Debug Toolbar Git

Symfony toolbar add-on

Get the latest git commit into Symfony debug toolbar

And visualize quickly the latest commit into your repository by clicking on the Commit ID.

Information displayed :

• Branch : active branch
• Time since last commit : time since last commit at page generation

1. less than one hour : minutes + seconds | colored in green, then in red :
2. more than one hour : hour(s)
3. more than 24h : count in days
4. more than 1 month : count in months

Useful for local development but also for a continuous integration (CI) process on a development server.

If no git repository have been initiated, there will be no display into the toolbar.

Status information : mouse over

Information displayed :

• Commit ID : links to the commit URL on your repository (Github, Bitbucket..), base url is to set into repository_commit_url parameter
• Merge : merge IDs if there is
• Author
• Email : email with active link
• Date : full date of latest commit
• Commit message

Installation

Composer

composer require kendrick/symfony-debug-toolbar-git

Register into AppKernel

app/AppKernel.php :

if (in_array($this->getEnvironment(), array('dev', 'test'))) {
    [...]
    $bundles[] = new Kendrick\SymfonyDebugToolbarGit\SymfonyDebugToolbarGit();

Parameters

app/config/config_dev.yml :

symfony_debug_toolbar_git:
    repository_commit_url: ""

repository_commit_url, ex : https://bitbucket.org/team/project/commits/ or https://github.com/user/project/commit/

More tools

Google Analytics API v4 Symfony bundle : https://github.com/mediafigaro/google-analytics-api-symfony

symfony-debug-toolbar-git's Issues

[Insight] Text files should end with a newline character - in composer.json, line 23

in composer.json, line 23

This file ends with no newline character. It won't render properly on a terminal, and it's considered a bad practice. Add a simple line feed as the last character to fix it.

https://help.github.com/articles/dealing-with-line-endings/

  "autoload": {
    "psr-4": {
      "Kendrick\\SymfonyDebugToolbarGit\\": "."
    }
  }
}

---

Posted from SensioLabsInsight

broken commit url

http://i.imgur.com/bBSMhbq.png

need a "/" between commit and commit ##

Use symfony-web-dir instead of hardcoded '../web'

https://github.com/kendrick-k/symfony-debug-toolbar-git/blob/master/DataCollector/GitDataCollector.php#L38

This line assumes that the web dir is alway 'web', but it should use composer.json: extra.symfony-web-dir:

https://symfony.com/doc/current/configuration/override_dir_structure.html#override-the-web-directory

Compatibility with Symfony 4.x

The symfony_debug_toolbar_git.data_collector.template with value "SymfonyDebugToolbarGit:Collector:git" is not found in symfony 4.x because it search over the main templates not over the vendors.

If I extend it to my templates folders works.

I don't know if there is a way to pass the correct route to this to handle the vendors once

Here is the error log

request.CRITICAL: Uncaught PHP Exception UnexpectedValueException: "The profiler template "SymfonyDebugToolbarGit:Collector:git.html.twig" for data collector "datacollector_git" does not exist." at /var/www/mydemo/vendor/symfony/web-profiler-bundle/Profiler/TemplateManager.php line 90 {"exception":"[object] (UnexpectedValueException(code: 0): The profiler template \"SymfonyDebugToolbarGit:Collector:git.html.twig\" for data collector \"datacollector_git\" does not exist. at /var/www/mydemo/vendor/symfony/web-profiler-bundle/Profiler/TemplateManager.php:90)"} []

Layout broken

In symfony2.3.30 layout is broken. Yep, its very old, but vendors list in application is huge and nightmare vendor upgrade are still in progress.

just wonder - is it only vendors issue?

Feature to see all directories versioned by git

Currently the toolbar only sees versioned directories in the root of application.
I like to discuss the viability of implement a feature to make the toolbar see all versioned packages. For example, some isolated bundles in other directories.
What do you think?

Refactoring

We need to apply some improvements in the code before you make the changes to get catch any git repository.
I will apply the extract methods.

example:
elseif (strpos($d, 'Author') === 0) you get author commit,

we would do something like:
$this->data['author'] = Git::shell('git log -1 --pretty=%an');
or
$this->data['author'] = Git::shell(GitCommand::AUTOR_LAST_COMMIT):

What do you think ?

fatal: Not a git repository (or any of the parent directories): .git

Hi,
when I execute phpunit and the project isn't in a git environement, I have a lot of:
fatal: Not a git repository (or any of the parent directories): .git

Maybe we can test for a .git folder before doing the command?