Download the PHP package sunnynath/laravel-release-manager without Composer

Laravel Release Manager

Enterprise-ready application release metadata and version governance for Laravel applications.

sunnynath/laravel-release-manager is a standalone Laravel package for exposing, resolving, caching, and automating application release metadata. It is designed for teams that need a reliable way to answer simple but important production questions:

• What version is currently deployed?
• Which build, branch, and commit produced this runtime?
• Where should release metadata come from in CI/CD?
• How can APIs and operational tooling expose release details safely?
• How can Git tags and version files stay in sync?

The package follows Semantic Versioning for application release versions and supports Laravel package auto-discovery.

Requirements

• PHP 8.2 or higher
• Laravel 10, 11, or 12
• Composer
• Git, only when using Git-backed release automation commands

Installation

Install the package with Composer:

Laravel auto-discovers the service provider and facade. Publish the configuration file:

This publishes:

Quick Start

Set a release version in your environment:

Show the current release metadata:

Use the helper functions anywhere in your Laravel app:

Render the application version in Blade:

Use the facade:

Configuration

After publishing the config file, configure release metadata in config/release-manager.php.

Common environment variables:

Cache configuration:

Optional metadata endpoint configuration:

Git automation configuration:

Compatibility governance configuration:

Audit logging configuration:

Version Resolution

Versions are resolved from configured sources in deterministic priority order. The first source that returns a non-empty valid Semantic Version wins.

Available sources:

If no configured source returns a version, the package uses fallback_version.

Supported version examples:

The leading v is accepted and normalized away.

Release Metadata

release_metadata() and Release::metadata() return a ReleaseMetadata value object with:

Example:

Compatibility Governance

API client compatibility checks. Configure a minimum supported client version:

Attach the middleware to API routes:

Compatible clients pass through when their header satisfies the configured minimum:

Incompatible clients receive a structured JSON response:

You can also use the service directly:

Artisan Commands

release:show

Displays the resolved application release metadata.

release:bump

Bumps the resolved version and writes it to the configured version file.

Supported bump parts:

release:sync

Finds the latest valid Semantic Version from Git tags and writes it to the configured version file.

release:tag

Previews or creates a Git tag for a release version.

By default, release:tag is a preview. Pass --create to actually create the Git tag. The options --create and --dry-run cannot be used together.

release:doctor

Checks release manager configuration and Git automation readiness. This is the fastest way to catch malformed source priority, invalid Semantic Versions, invalid release channels, missing Git state, and command setup issues.

All release automation commands support --json and --ci for CI/CD pipelines. The --ci option implies machine-readable JSON output and deterministic exit codes.

In CI mode, release:doctor fails only for critical problems such as invalid configuration or an unresolvable release version. Non-critical readiness warnings, such as optional Git details not being available, are reported in JSON without failing the process.

Laravel About Command

The package registers release details with Laravel's built-in about command:

The Laravel Release Manager section includes:

• Package name and package version
• Resolved application version
• Release channel
• Build number, commit hash, and branch
• Minimum supported client version
• Cache and metadata endpoint status

Audit Logging

Release-changing commands write compact audit log entries after real changes:

Dry runs are not logged. Disable logging with:

HTTP Headers

Attach the middleware to routes that should expose release headers:

The middleware adds:

You may also reference the middleware class directly:

Optional Metadata Endpoint

The JSON metadata endpoint is disabled by default because release metadata can be operationally sensitive.

Enable it in config/release-manager.php:

Then request:

Example response:

For production APIs, protect this endpoint with your own middleware when needed:

Blade Usage

Render the current application version:

Example footer:

Facade And Helpers

Helpers:

Facade:

CI/CD Examples

Bump a patch version and create a tag:

Sync the application version from Git tags:

Read machine-friendly metadata:

Contributing

Contributions are welcome through pull requests.

The usual workflow is to fork the repository, create a branch in your fork, make the change, and open a pull request back to this repository. Contributors do not need branches inside the main repository.

Then open a pull request from your fork. Please include a short explanation of the change and tests when the change affects behavior.

Testing

From the package root:

Run Composer validation before tagging a release:

License

Laravel Release Manager is open-sourced software licensed under the MIT license.