Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Latest
------

## Changes
* [#90](https://github.com/cleverage/process-bundle/issues/90) Installation documentation: describe the Symfony Flex recipe ([symfony/recipes-contrib#2081](https://github.com/symfony/recipes-contrib/pull/2081)), which registers the bundle and creates `config/packages/clever_age_process.yaml` importing the `config/packages/process/` directory, and the manual setup without Flex.

v5.2
-----

Expand Down
20 changes: 19 additions & 1 deletion docs/01-quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,30 @@ Open a command console, enter your project directory and install it using compos
composer require cleverage/process-bundle
```

Remember to add the following line to `config/bundles.php` (not required if Symfony Flex is used):
With [Symfony Flex](https://symfony.com/doc/current/setup/flex.html), the
[recipe](https://github.com/symfony/recipes-contrib/tree/main/cleverage/process-bundle) registers the bundle and creates:
- `config/packages/clever_age_process.yaml`: the [global configuration](#global-configuration), which imports the
`config/packages/process/` directory,
- `config/packages/process/`: the directory of your processes, one file per process (see
[process definition](reference/01-process_definition.md)).

Without Flex, add the following line to `config/bundles.php`:

```php
CleverAge\ProcessBundle\CleverAgeProcessBundle::class => ['all' => true],
```

Then create the `config/packages/process/` directory and the configuration that imports it:

```yaml
# config/packages/clever_age_process.yaml
imports:
- { resource: process/ }

clever_age_process:
default_error_strategy: stop
```

Some tasks and transformers use the main Symfony serializer service, and the bundle checks at container compilation
that it is available: if it is not, the build fails with an explicit message. Make sure it is enabled
(see [`framework.serializer.enabled`](https://symfony.com/doc/current/reference/configuration/framework.html#reference-serializer-enabled)):
Expand Down
Loading