markwalet/laravel-git-state

A Laravel package that gives you information about the current git state.

v1.9.1 2024-11-19 10:21 UTC

Requires

• php: ^8.1
• laravel/framework: ^10.0|^11.0
• phpoption/phpoption: >=1.8
• webmozart/assert: ^1.10

Requires (Dev)

• orchestra/testbench: 8.*|9.*
• phpunit/phpunit: ^10.5

MIT

• Mark Walet

README

A Laravel package that gives you information about the current git state.

Installation

You can install this package with composer:

composer require markwalet/laravel-git-state

Laravel auto-loads service providers for you, so you don't have to register it. If you want to register the service provider manually, add the following line to your config/app.php file:

MarkWalet\GitState\GitStateServiceProvider::class

Usage

When you want to get information about the current git state, you can inject the MarkWalet\GitState\Drivers\GitDriver class in your methods:

<?php

use MarkWalet\GitState\Drivers\GitDriver;

class Controller {
    
    public function index(GitDriver $driver) {
        $branch = $driver->currentBranch();
        $commit = $driver->latestCommitHash();
        
        return view('index', compact('branch', 'commit'));
    }
}

When injecting a GitDriver like this, you will get an instance of the default driver you configured. If you want to have more control over the driver you are using, you can use the MarkWalet\GitState\GitManager:

<?php

use MarkWalet\GitState\GitStateManager;

class Controller {
    
    public function index(GitStateManager $driver) {
        $branch = $driver->driver('other-driver')->currentBranch();
        
        return view('index', compact('branch'));
    }
}

Configuration

The default configuration is defined in git-state.php. If you want to edit this file you can copy it to your config folder by using the following command:

php artisan vendor:publish --provider="MarkWalet\GitState\GitServiceProvider"

In this file you can configure different drivers for fetching the current Git state, as well as setting a default configuration.

The supported drivers are: exec and file. There is also a fake implementation for testing purposes.