- What is juststeveking/laravel-envoyer-sdk used for?
- It is a Laravel-focused PHP client for the Laravel Envoyer REST API. It gives you a fluent interface to work with Envoyer projects, servers, deployments, and hooks from application code or Artisan commands. It is only useful if Envoyer is already your deployment mechanism, and it should sit behind an internal service wrapper rather than leaking into controllers.
- How do I install and configure laravel-envoyer-sdk in a Laravel app?
- Install it with Composer, let Laravel discover the service provider, publish the package config, and provide your Envoyer API token. Then make a safe read-only call, such as listing projects, to confirm authentication before wiring up deployment actions. Keep the token out of committed config and load it from environment variables or a secret manager.
- Which PHP and Laravel versions does this Envoyer SDK support?
- The v2.0.0 release added PHP 8 support, and the last release was dated 2022-05-31. Current Laravel major-version compatibility is not verified by the package metadata, so validate it against your exact PHP and Laravel line before adopting it. Budget for a fork or local patch at your next framework upgrade if it lags.
- Can I trigger an Envoyer deployment from Laravel with this package?
- Yes, the package is designed to call the Envoyer API, including deployment-related operations exposed by the SDK. A successful trigger only means Envoyer accepted the deployment request, not that the deployment completed. Poll and model status with an enum that includes terminal states, never with a boolean.
- Is laravel-envoyer-sdk safe for production deployment automation?
- Treat it as acceptable only for low-criticality automation with a named internal owner, not as an unmonitored path that production releases depend on. The package has a single maintainer, low adoption, and no releases since May 2022, so longevity and security response are unproven. Put it behind an internal EnvoyerDeployer interface and document token rotation and revocation before first use.
- What Envoyer operations does the SDK cover?
- The package aims to cover core Envoyer resources such as projects, servers, deployments, and hooks through typed requests. Before committing, enumerate the exact operations your use case needs and prove coverage against a throwaway Envoyer project. If something is missing, decide whether dropping to the raw HTTP client inside your wrapper is acceptable.
- How should I store and rotate the Envoyer API token?
- Use an environment variable or secret manager, never committed application config or a shared CI variable without controls. The token is account-scoped and can trigger deployments across every project the account owns, so blast radius is broad. Assign an owner, write a rotation runbook, and define a revocation procedure before the first real deployment.
- How do I test laravel-envoyer-sdk without triggering real deployments?
- Unit-test your own EnvoyerDeployer wrapper with mocked responses so product code never depends directly on the package. For integration confidence, use a throwaway Envoyer project and a real token to exercise authentication, reads, triggers, and status polling. Do not assume the package has a trusted regression suite; verify whether you are effectively the test suite.
- What changed in v2.0.0 of laravel-envoyer-sdk, and is it breaking?
- The major release documentation mentions only PHP 8 support, with no detailed API-surface changelog. That likely means moved transitive floors such as Saloon or Guzzle and tightened types or return signatures, so treat v2.0.0 as breaking until diffed against your call sites. Smoke-test installation and every used operation rather than trusting a clean Composer update.
- What are the alternatives if this Envoyer SDK is abandoned?
- Keep the package behind an internal interface so you can swap it for a hand-rolled Envoyer API client or direct HTTP calls without changing product code. The exit cost then depends on how many wrapper methods you use, not how many call sites touch the SDK. Given the low release cadence, plan the swap path at the same time you approve adoption.