Skip to content

#320 - README: add an installation section #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
njoubert-cleverage merged 2 commits into from
Oct 20, 2026
Merged

#320 - README: add an installation section #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd52a43
#320 - README: add an installation section
njoubert-cleverage Oct 20, 2026
ef8fe1c
Merge branch 'main' into 320
njoubert-cleverage Oct 20, 2026
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* [#319](https://github.com/cleverage/process-bundle/issues/319) Composer: require PHP `^8.2` instead of `>=8.2` (PHP 9 is no longer accepted before being tested), remove the authorization of the `symfony/flex` plugin, which is not required (the CI installs it globally).
* [#318](https://github.com/cleverage/process-bundle/issues/318) `CommandRunnerTask`, `ProcessLauncherTask` and `SubprocessInstance` receive the project directory, the path of the console and the environment (`%kernel.project_dir%`, `%kernel.environment%`) instead of the kernel: passing a `KernelInterface` is deprecated, the arguments will only accept strings in v6.0. `SubprocessInstance` writes the JSON buffer of `ProcessLauncherTask` (`json_buffering`) in the system temporary directory instead of `var/` of the project (which may be read-only), no longer creates the unused `<log dir>/process` directory, and omits `--env` when no environment is given (default environment of the console). Update documentation, add tests.
* [#317](https://github.com/cleverage/process-bundle/issues/317) The bundle throws exceptions implementing `ProcessExceptionInterface` instead of raw SPL exceptions (124 `throw`): new `Exception\UnexpectedValueException`, `RuntimeException`, `InvalidArgumentException` and `LogicException`, extending the SPL exceptions thrown before (same messages, the existing `catch` keep working). All the errors of the bundle can be caught with `ProcessExceptionInterface`, except the exceptions of the Symfony components. Update documentation, add tests.
Expand Down
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading