Update documentation for task runner, [tasks] config, and explicit foreground mode
#2
Conversation
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
Update the README to document the new `[tasks]` section in `proc.toml`, the `oxproc run <task>` workflow, and default command behavior. Provide examples for process and task configuration, and clarify that tasks are exclusive to TOML setups, not supported via Procfile. Note the explicit invocation required for formerly-default foreground (dev) mode. This change is needed so users can discover how to use task-based CLI flows and avoid confusion from the new, explicit UX separating process management from task/command execution. BREAKING CHANGE: Default invocation of `oxproc` now prints help instead of running all processes in foreground; users must use `oxproc run dev` or equivalent task.
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.
Summary
This PR updates the README to reflect recent changes to task runner functionality, including
[tasks]configuration, updated CLI usage, and behavioral changes for default commands.Details
[tasks]section andoxproc run <task>usage, with detailed examples.proc.tomland covers Procfile limitations.