VCR.AM PHP Monorepo

This repository hosts the PHP-side of the VCR.AM Virtual Cash Register ecosystem: a framework-agnostic SDK plus thin adapters for popular PHP frameworks and e-commerce platforms.

Packages

Package	Composer name	Status
packages/sdk	blob-solutions/vcr-am-sdk	Released (0.x) — framework-agnostic SDK. PSR-3, PSR-17, PSR-18.
packages/laravel	blob-solutions/laravel-vcr-am	Pre-release — thin Laravel adapter (ServiceProvider, Facade, config, Artisan). Tagged & published from Phase 4 onwards.

Each package is published to Packagist independently from a read-only mirror repository (split out of this monorepo on every tag). End users composer require packages directly — they never need to clone this monorepo.

Why a monorepo

• Atomic changes — when the SDK signature evolves, every adapter PR lands in the same commit and CI runs as one matrix.
• Coordinated versions — adapters stay in lockstep with SDK majors; no compatibility matrix to maintain.
• One source of truth — single Pint style, single PHPStan baseline, single CI configuration.

The pattern follows Symfony's and Laravel's monorepo layouts: source lives here, individual packages are mirrored to their own repos via splitsh/lite on tag push.

Repository layout

.
├── bin/each                ← run `composer <cmd>` in every package
├── composer.json           ← orchestrator (not published)
├── packages/
│   ├── sdk/                → mirror: blob-am/vcr-am-sdk-php      → blob-solutions/vcr-am-sdk
│   └── laravel/            → mirror: blob-am/laravel-vcr-am      → blob-solutions/laravel-vcr-am
└── .github/workflows/
    ├── ci.yml              ← matrix tests for every package
    └── release.yml         ← splitsh on `v*` tag, GitHub release

Local development

Requirements: PHP 8.2+, Composer 2.x, Bash.

# Install dependencies for every package
composer install:all

# Run the full local CI gate (pint + phpstan + pest) across every package
composer check

# Per-package commands work too
cd packages/sdk && composer test

Each package has its own composer.json and is fully self-contained — you can develop and test it standalone after cd packages/<name>.

Versioning

All packages share a single version tag. A v0.5.2 tag in this repo produces a 0.5.2 release of every published package, even ones whose source did not change in that release. This keeps cross-package compatibility trivial: laravel-vcr-am ^0.5 always pairs with vcr-am-sdk ^0.5.

Releasing

git tag v0.X.Y && git push origin v0.X.Y

The release.yml workflow then:

1. Creates a GitHub release on the monorepo with auto-generated notes.
2. Mirrors packages/sdk/ → blob-am/vcr-am-sdk-php.
3. Sanitises and mirrors packages/laravel/ → blob-am/laravel-vcr-am (strips dev-only path repo + stability flags).
4. Re-tags both mirrors so Packagist webhooks publish automatically.

See docs/releasing.md for one-time mirror/PAT setup, sync versioning rationale, and yank/troubleshooting recipes.

License

ISC — same for every package in the monorepo.