Gitlib Laravel Package

Getting Started

Install via Composer: composer require gitonomy/gitlib. Start by instantiating a GitRepository object pointing to an existing local Git repo path:

$repository = new GitRepository('/path/to/repo');
$history = $repository->getLog(); // Fetch commit history

First use case: programmatically inspect repository history, branches, or tags—ideal for CI dashboards, deployment tools, or Git GUIs built in PHP.

Implementation Patterns

• Repository introspection: Use getLog(), getBranches(), getTags(), getDiff(), and getShortLog() to power audit trails or visualizations.
• Command chaining: Wrap repeated Git operations in wrapper classes or services (e.g., GitAuditService) to avoid duplication.
• Event-driven hooks: Integrate with Laravel events to trigger actions (e.g., deploy notifications) after detecting new commits via polling or webhook-induced checks.
• Asynchronous batch processing: Use Laravel queues to run heavy operations (e.g., git gc, large diffs) without blocking HTTP requests.

Gotchas and Tips

• Path validation: Always normalize and validate repository paths before instantiation—git commands fail silently or throw exceptions on invalid paths.
• Encoding matters: Git outputs may be UTF-8 or locale-dependent; explicitly set LC_ALL=C or decode output manually if multilingual content is involved.
• Streaming large outputs: Use execute() with callbacks instead of getOutput() for large logs to avoid memory exhaustion.
• Extended exceptions: Catch Gitonomy\Git\Exception\ProcessException to access exit code, stdout, and stderr—vital for debugging misconfigured repos or permission issues.
• Extension tip: Fork or wrap gitonomy/gitlib in a Laravel service provider to inject config (e.g., default timeout, bin path) and ensure testability via mocks in feature tests.