Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/KOJO-210 | advertise the KojoWorkerDecoratorComponent, KojoWorkerDecoratorComponentFitness, kojo-phinx-templates #119

Open
wants to merge 2 commits into
base: 5.x
Choose a base branch
from
Open

Feature/KOJO-210 | advertise the KojoWorkerDecoratorComponent, KojoWorkerDecoratorComponentFitness, kojo-phinx-templates #119

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
0ec9041
suggest decorator component and phinx templates
alexberryman Mar 11, 2021
d1cfade
advertise the KojoWorkerDecoratorComponent, KojoWorkerDecoratorCompon…
alexberryman Mar 11, 2021
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ A distributed task manager.

Real-world use cases for Kōjō and instructions for getting Kōjō up and running in your project can be found at [KojoFitness](https://github.com/neighborhoods/KojoFitness).

Building well-behaved Kōjō jobs is made easier by [KojoWorkerDecoratorComponent](https://github.com/neighborhoods/KojoWorkerDecoratorComponent). Using these decorators helps adhere to best practices like sharing PDO connections, handling exceptions, and controlling retry and crash loops within a job's lifecycle. Code examples of how to use these decorators can be seen in [KojoWorkerDecoratorComponentFitness](https://github.com/neighborhoods/KojoWorkerDecoratorComponentFitness).

Managing the database definitions of Kōjō jobs is made easier with the [Phinx templates for Kōjō](https://github.com/neighborhoods/kojo-phinx-templates) which provides DB migration templates for creating Kōjō job definitions and DB seeds for instantiating jobs.

## Debugging Kōjō
XDebug version greater than `xdebug-2.7.0alpha1` is required when trying to debug Kōjō. This version of XDebug resolves issues (https://bugs.xdebug.org/938) caused by the way the Kōjō forks using `pcntl`.

Expand Down
5 changes: 5 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@
"phpunit/phpunit": "^7.0",
"phpunit/dbunit": "^4.0"
},
"suggest": {
"neighborhoods/kojo-worker-decorator-component": "useful PDO and exception decorators for making well-behaved Kōjō jobs",
"neighborhoods/kojo-worker-decorator-component-fitness": "examples on how to use the KojoWorkerDecoratorComponent",
"neighborhoods/kojo-phinx-templates": "Database migrations and seeds for defining and creating Kōjō jobs"
},
"bin": [
"bin/kojo",
"scaffolding/bin/scaffolding.php"
Expand Down