Download the PHP package bizkit/versioning-bundle without Composer

BizkitVersioningBundle

Symfony bundle which provides a way to version your application using various versioning strategies.

Features

• Stores the application's version & release date into a compliant YAML or XML Symfony container configuration file
• Automatically imports the file with the parameters into Symfony's container
• Supports multiple versioning strategies & creating custom ones
• Includes a console command for incrementing the version using the configured versioning strategy
• The command automatically commits the version file & optionally creates a tag if a VCS handler is configured
• Supports the Git VCS & creating custom VCS handlers

Requirements

• PHP 7.2 or higher
• Symfony 4.4 or Symfony 5.2 or higher

Installation

1. Require the bundle using Composer:

2. Create a configuration file under config/packages/bizkit_versioning.yaml. Here's a reference configuration:

3. If your project doesn't use Symfony Flex, enable the bundle in config/bundles.php by adding it to the array:

Usage

The bundle creates a compliant Symfony Dependency Injection Container configuration file with the following three parameters:

• application.version - the application's version (the format depends on the configured versioning strategy)
• application.version_hash - an MD5 digest of the version
• application.release_date - an RFC 3339 formatted date on which the version was last incremented

NOTE: The parameter names mighty vary depending on the parameter_prefix configuration option.

It automatically adds the parameters into Symfony's container by registering the file as an import.

To find out more about parameters check Symfony's official documentation. The following example shows how to use it with Sentry's Monolog handler:

Incrementing the version

To increment the version using the configured strategy run the following command:

If you have a VCS handler configured, the command will automatically commit the version file & optionally create a tag with the new version.

Versioning strategies

The bundle comes with the following version strategies:

1. incrementing - defines the version as an incrementing number
2. semver - uses the Semantic Versioning system

Custom strategies

To implement a custom strategy all you need to do is create a service which implements the StrategyInterface interface.

Use the FQCN of the service in the configuration:

If you are not using Symfony's autoconfigure feature or wish to use an alias in the configuration, tag the service with the bizkit_versioning.strategy tag.

VCS handlers

The bundle comes with a handler for the Git VCS. If you wish to disable the VCS feature, set the vcs configuration option to false:

Custom VCS handlers

To implement a custom VCS handler all you need to do is create a service which implements the VCSHandlerInterface interface.

Use the FQCN of the service in the configuration:

If you are not using Symfony's autoconfigure feature or wish to use an alias in the configuration, tag the service with the bizkit_versioning.vcs_handler tag.

Versioning

This project follows Semantic Versioning 2.0.0.

Reporting Issues

Use the issue tracker to report any issues you encounter.

License

See the LICENSE file for details (MIT).