zenstruck/version-bundle

Keep track of your Symfony2 application's version

Introduction

Keep track of your Symfony2 application's version. Knowing what build/version number an application in staging/production is important., _(*1)

Many projects have a VERSION or BUILD file created by the developer or CI server. This bundle provides a block, twig function, and web debug toolbar panel to output both the application's and Symfony's version. The version is available throughout your project as a service. You can inject the current version in perhaps a meta tag for your production environment., _(*2)

Installation

1. Install the bundle through composer :

javascript { "require": { // ... "zenstruck/version-bundle": "dev-master" } }, _(*3)

1. Create a VERSION file in your project's root directory, _(*4)

2. Configure the bundle:, _(*5)

   # Example
   # app/config_dev.yml
   zenstruck_version:
       enabled: true
       toolbar: true
   
   #app/config_staging.yml
   zenstruck_version:
       enabled: true
       toolbar: false
       block:
           enabled: true

Usage

When enabled, this plugin defines two twig functions:, _(*6)

• version(): outputs the current application version (as defined in your VERSION file)
• symfony(): outputs the current Symfony version (as defined in Symfony\Component\HttpKernel\Kernel::VERSION)

And adds a service to Symfony's service container:, _(*7)

• zenstruck.version.data_collector

Examples

Access service in a controller:, _(*8)

...
public function indexAction()
{
    $versionDC = $this->get('zenstruck.version.data_collector');

    $appVersion = $versionDC->getVersion();
    $symfonyVersion = $versionDC->getSymfony();
    ...
}
...

Render in template:, _(*9)

{# twig template #}
{{ version() }}
{{ symfony() }}

Render a meta tag with application version and Symfony version:, _(*10)

...
<meta name="version" content="{{ version() }}" />
<meta name="symfony" content="{{ symfony() }}" />
...

Extend

Use your own Version DataCollector

1. Overrride the default VersionDataCollector class:, _(*11)

   // MyVersion.php
   use Zenstruck\Bundle\VersionBundle\DataCollector\VersionDataCollector;
   
   class MyVersion extends VersionDataCollector
   {
       public function getVersion()
       {
           return $myversion;
       }
   }

2. Set you VersionDataCollector class in app/config.yml:, _(*12)

   // app/config.yml
   parameters:
       zenstruck.version.data_collector.class: \MyVersion

Full Default Configuration

# config.yml
zenstruck_version:
    enabled: false                      # enable/disable service
    toolbar: false                      # show in web debug toolbar
    file: %kernel.root_dir%/../VERSION  # the file containing version info
    suffix: ~                           # suffix text (ie "-dev")
    version: ~                          # overrides file/text with custom version
    block:
      enabled: false                    # enable/disable block
      position: vb-bottom-right         # other values: vb-bottom-left, vb-top-right, vb-top-left
      prefix: "Version: "               # text added to beginning of block