From dd52a434621ada17f7c6ffbd7d5f88303e6f292f Mon Sep 17 00:00:00 2001 From: Nicolas Joubert Date: Tue, 20 Oct 2026 16:19:13 +0200 Subject: [PATCH] #320 - README: add an installation section composer require, bundle registration without Symfony Flex, link to the quick start. Co-Authored-By: Claude Opus 5.5 (1M context) --- CHANGELOG.md | 1 + README.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cdb6fbbe..b890715b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ Latest ------ ## Changes +* [#320](https://github.com/cleverage/process-bundle/issues/320) README: add an installation section (`composer require`, bundle registration without Symfony Flex), linking to the quick start. * [#311](https://github.com/cleverage/process-bundle/issues/311) Deprecate the `cleverage_process.event_listener.data_queue` service and `DataQueueEventListener` (it keeps a copy of the `ProcessState` of every `cleverage_process.data_queue` event in memory, without limit): injecting or fetching the service triggers a deprecation, they will be removed in v6.0. Write your own listener of the event dispatched by the `event_dispatcher` task. Update documentation, add tests. * [#312](https://github.com/cleverage/process-bundle/issues/312) Add read-only interfaces for the process manager and the registries, implemented by the existing classes and autowired by their interface: `ProcessManagerInterface` (`execute()`), `ProcessConfigurationRegistryInterface` (`getProcessConfiguration()`, `getProcessConfigurations()`, `hasProcessConfiguration()`), `TransformerRegistryInterface` (`getTransformer()`, `getTransformers()`, `hasTransformer()`) and `TaskRegistryInterface` (`getTask()`). Type your services on them: the classes will be `final` in v6.0 (the services of the bundle will then be typed on the interfaces). Update documentation, add tests. * [#310](https://github.com/cleverage/process-bundle/issues/310) Process configuration tree: a task `error_strategy` other than `skip` or `stop` is deprecated (notice when the container is compiled; it was accepted and the process failed with "Unknown error strategy" when the task failed), it will be rejected in v6.0. The process `public` key is a boolean node: a non-boolean value is rejected when the container is compiled, instead of a `TypeError` when the configuration is built. Describe the nodes of the process, task and generic transformer configurations (`config:dump-reference clever_age_process`). Update documentation, add tests. diff --git a/README.md b/README.md index 8c2b601b..65e1ffb4 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ Compatible with [Symfony stable version and latest Long-Term Support (LTS) relea Demo project can be found on [there](https://github.com/cleverage/process-bundle-demo). +## Installation + +```bash +composer require cleverage/process-bundle +``` + +Without Symfony Flex, register the bundle in `config/bundles.php`: + +```php +CleverAge\ProcessBundle\CleverAgeProcessBundle::class => ['all' => true], +``` + +Then define your first process: see the [quick start](docs/01-quick_start.md) (optional dependencies, configuration, commands). + ## Documentation For usage documentation, see: