- How do I install laravel-jira-rest-client in a Laravel app?
- Run composer require rjvandoesburg/laravel-jira-rest-client, then publish the package config with the vendor:publish command so config/jira.php lands in your application. Set your Jira host, username and API token in the config file or the matching environment variables, and let Laravel auto-discover the service provider. You can then resolve the Jira facade or inject the client from the container. A working proof of concept against a Jira sandbox usually takes hours, not days.
- Does this package support Jira Cloud and Jira Data Center?
- The wrapper targets Jira's REST API generally, but Cloud and Data Center diverge on authentication (API token plus email versus personal access token or basic auth), field schemas and endpoint deprecations. Test against the exact deployment you are pointed at before committing, because anything hardcoded to an older API surface becomes your problem. Decide up front whether you need Cloud, Data Center or both.
- Which Laravel and PHP versions are compatible with laravel-jira-rest-client?
- Compatibility is driven mostly by the underlying lesstif/php-jira-rest-client dependency rather than this wrapper, so check both composer.json files against your Laravel and PHP versions. Avoid relying on --ignore-platform-reqs to force an install, since that just defers a runtime failure. Pin the versions you validate and monitor Laravel major releases for service provider and config publishing drift.
- How does authentication work and where should I store Jira credentials?
- Credentials live in config/jira.php or the corresponding .env entries, typically host, username and either an API token or personal access token. The package does not manage token rotation, per-tenant isolation or secret storage for you, so keep those concerns in your own configuration layer. Use environment-specific secrets and never commit tokens to the repository.
- Can I create issues, transition workflows and add comments with this package?
- Yes, the wrapper exposes Jira REST operations for issues, projects, users, attachments and comments, including write paths such as creating issues and transitioning workflows. Write operations carry significantly more schema-drift risk than read-only JQL queries because they depend on field IDs and transition IDs specific to each Jira instance. Wrap write calls behind your own adapter so you can adjust them in one place.
- How do I test Laravel code that calls Jira?
- Do not let the Jira facade leak into domain code; define an internal interface such as JiraGateway and implement it with this package. That lets you bind a fake or stub in the container during tests and swap the vendor client later. The package itself is a thin wrapper, so most of the logic worth testing is yours anyway.
- Is laravel-jira-rest-client suitable for multi-tenant apps with multiple Jira instances?
- Not out of the box. The published config is effectively a singleton, so per-customer credentials mean re-binding or reconfiguring the client at runtime, which steps outside the package's happy path. If multi-tenant Jira access is a core requirement, evaluate that early or build your own client factory around the underlying library.
- Is the package actively maintained and safe to use in production?
- Adoption signal is low at roughly 45 stars with a single maintainer, so there is no commercial support path or security patch SLA. The license is MIT, which means forking or vendoring internally is legally unencumbered and materially lowers the risk. Pin the version, monitor releases of the lesstif dependency, and have a plan for owning the code if the maintainer goes quiet.
- How does this compare to calling the Jira REST API with Guzzle directly?
- This package is a thin Laravel service-provider wrapper around lesstif/php-jira-rest-client, giving you a configured client, a facade and a publishable config instead of hand-rolled HTTP calls. It saves boilerplate, but the abstraction is shallow: you get array-shaped helpers, not a domain model. If your Jira usage is incidental that is a reasonable trade, but if Jira integration is your product's core competency the wrapper adds little.
- How do I query issues with JQL and work with custom fields?
- JQL strings are passed through to Jira, so you compose the query yourself and the package returns array-shaped responses. Custom fields require instance-specific field IDs, and ADF or rich-text rendering is not handled for you. Plan on writing your own mapping layer for anything beyond simple reads.