Weave Code
At a glance
Frequently asked questions about Automation Bundle
- What is SuluAutomationBundle used for?
- SuluAutomationBundle lets you manage future tasks that are scheduled for entities in the Sulu Admin. A common example is scheduling a page to be published at a specific datetime. It is an official Sulu bundle built around the php-task library rather than a general Laravel scheduler.
- How do I install SuluAutomationBundle?
- Install it with Composer using sulu/automation-bundle and then follow the bundle's installation documentation in Resources/doc/installation.md. The README points to that document for registration and setup details. Because it is a Sulu bundle, install it in a Sulu project rather than a plain Laravel application.
- Does SuluAutomationBundle work with Laravel?
- No, SuluAutomationBundle is a Sulu bundle, not a Laravel package. It is marked compatible with Sulu ^3.0 and depends on Sulu's admin and entity model. Laravel-only applications should use Laravel's scheduler and queue system instead.
- Which Sulu version is SuluAutomationBundle compatible with?
- The README badge lists Sulu compatibility as ^3.0. That means you should use it with a Sulu 3.x project and check composer.json for the precise dependency constraints. If you are on an older Sulu release, verify compatibility before adding the bundle.
- How do I schedule a page to publish at a future date?
- In the Sulu Admin you can schedule future tasks for entities, and the README gives publishing a page at a specific datetime as the example. The bundle stores and manages those scheduled tasks through php-task. For exact UI steps and configuration, use the bundle documentation in Resources/doc.
- What are the requirements for using SuluAutomationBundle?
- The README lists Composer as a requirement and points to composer.json for detailed requirements. It also indicates Sulu ^3.0 compatibility. In practice you need a working Sulu 3.x application with its normal PHP and Symfony dependencies.
- How does SuluAutomationBundle schedule and run tasks?
- It uses the php-task library to manage scheduled future tasks for Sulu entities. You schedule a task, such as a future page publish, and the bundle integrates that task with Sulu's entity management. Production setups must ensure the php-task execution mechanism is running so scheduled work actually fires.
- Is SuluAutomationBundle safe to use in production?
- It is an official Sulu bundle under the MIT license, and the repository includes a test workflow. For production, treat scheduled publishing as critical automation and make sure your php-task runner and monitoring are reliable. Test the workflow in a staging Sulu project before relying on it for live content changes.
- How can I test automation tasks in a Sulu project?
- Use a basic project built with sulu/skeleton to reproduce issues and test scheduled tasks, as the README recommends for bug reports. Run your normal Sulu test suite and verify that php-task picks up and executes scheduled jobs. Check the repository's test workflow for the supported test setup.
- How is SuluAutomationBundle maintained and what alternatives exist?
- It is maintained as an official Sulu bundle with MIT licensing, GitHub issues, and a test workflow on the 3.0 branch. For a Laravel application, the closest alternative is Laravel's built-in scheduler and queues. Within Sulu, compare the bundle's php-task scheduling with your project's native publishing workflow and any other Sulu automation options you already use.
Weaver
How can I help you explore Laravel packages today?