https://github.com/flowpack/flowpack.prunner
An embeddable, API based pipeline runner. (Flow Package)
https://github.com/flowpack/flowpack.prunner
Last synced: about 1 month ago
JSON representation
An embeddable, API based pipeline runner. (Flow Package)
- Host: GitHub
- URL: https://github.com/flowpack/flowpack.prunner
- Owner: Flowpack
- License: mit
- Created: 2021-07-30T08:49:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-09T23:46:58.000Z (about 2 years ago)
- Last Synced: 2025-07-04T21:42:49.007Z (9 months ago)
- Language: PHP
- Size: 629 KB
- Stars: 2
- Watchers: 11
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flowpack.Prunner
**An embeddable task / pipeline runner for Neos and Flow.**
**For a full introduction, see the [README of the prunner repo](https://github.com/Flowpack/prunner)**.
## Components
### [prunner](https://github.com/Flowpack/prunner)
A single process, written in go, that provides the REST API, pipeline runner and persistence.
It needs to be started in the background for integration into other applications.
### [prunner-ui](https://github.com/Flowpack/prunner-ui)
A minimalistic React UI to start and view pipelines, jobs and task details.
### [Flowpack.Prunner](https://github.com/Flowpack/Flowpack.Prunner) (this repository)
A Neos/Flow PHP package providing a backend module for the current pipeline state, and a PHP API.
## Installation
```bash
composer require flowpack/prunner
```
Now, start up prunner via the following command:
```bash
prunner/prunner --path Packages --data Data/Persistent/prunner
```
This will parse all packages for `pipelines.yml` files.
## Overriding the Prunner Version
By default, the prunner version configured in `Flowpack\Prunner\Composer\InstallerScripts::DEFAULT_VERSION_TO_INSTALL`
will be downloaded. However, it is possible to override this via `extra.prunner-version` in the root `composer.json`:
```json
{
"extra": {
"prunner-version": "0.4.0"
}
}
```
## Skip the Prunner binary download
In case you want to install Prunner manually,
you can skip the download of the Prunner entirely
by setting `extra.prunner-version` in the root `composer.json` to `"skip-download"`.
```json
{
"extra": {
"prunner-version": "skip-download"
}
}
```
## Building the UI package
In [prunner-ui](https://github.com/Flowpack/prunner-ui), run `yarn build`
for the production build.
Then, copy the `index.js` and `index.css` files to this package:
```bash
export PRUNNERUI=/path/to/prunner-ui
cp $PRUNNERUI/build/dist/index.js* Resources/Public/prunner-ui/
cp $PRUNNERUI/build/index.css Resources/Public/prunner-ui/index.css
```
## License
MIT - see [LICENSE](LICENSE).