Repository navigation
Document the worker bootstrap file (ContextWorkerFactory) - #231
Open
AjmalAlkhaledi wants to merge 1 commit into
Open
AjmalAlkhaledi wants to merge 1 commit into
AjmalAlkhaledi wants to merge 1 commit into
Conversation
ContextWorkerFactory's first argument is a bootstrap file that is required in every worker before any task runs — the place to register a non-Composer autoloader or do per-worker setup. Documents amphp#201.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #201 (documentation).
ContextWorkerFactory's first constructor argument ($bootstrapPath) is a bootstrap file that is appended to the worker script andrequired in every worker before any task runs (seetask-runner.php). It's the intended place to register a non-Composer autoloader or do per-worker setup — but it isn't mentioned in the README, which (as #201 notes) can send users down the wrong path.This adds a short Bootstrapping workers subsection under Workers with the
ContextWorkerFactory/ContextWorkerPoolusage and a bootstrap-file example. Documentation only — no code changes.