feat!: modifying how tasks are selected in run command #37
Conversation
This file contains 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
ddneilson
force-pushed
the
ddneilson/16562
branch
2 times, most recently
from
ef7ca9d to
4bf96f0
Compare
AWS-Samuel
requested changes
Feb 9, 2024
Problem:
The way that tasks were selected for running in the `run` subcommand
was ambiguous. For example `openjd run -tp Foo=Bar template.json -tp
Buz=Baz ...` We allowed multiple values to a single `-tp` argument, and
that makes it less clear whether the 'template.json' in there is
intended to be the positionl argument or an incorrectly formed -tp
value.
Solution:
Reworked the way that tasks are selected. We now have:
```bash
openjd run template.json --task-param Foo=Bar --task-param Buz=Baz ... # -> Run a single task
openjd run template.json --tasks file://params.json # -> one or more tasks as defined in the file
openjd run template.json --tasks '[{ ... inline json...}]' # -> one or more tasks
```
That is, the `--task-param/-tp` option is now exclusively for the case
where you want to run a single task, and must be provided once for each
task parameter that needs to be defined.
Furthermore, the `--task-param/-tp`, `--tasks`, and `--maximum-tasks`
options have been made mutually exclusive.
Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
ddneilson
force-pushed
the
ddneilson/16562
branch
from
4bf96f0 to
e09d989
Compare
AWS-Samuel
approved these changes
Feb 9, 2024
npmacl
approved these changes
Feb 9, 2024
Merged
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.
What was the problem/requirement? (What/Why)
The way that tasks were selected for running in the
runsubcommand was ambiguous. For exampleopenjd run -tp Foo=Bar template.json -tp Buz=Baz ...We allowed multiple values to a single-tpargument, and that makes it less clear whether the 'template.json' in there is intended to be the positionl argument or an incorrectly formed -tp value.What was the solution? (How)
Reworked the way that tasks are selected. We now have:
That is, the
--task-param/-tpoption is now exclusively for the case where you want to run a single task, and must be provided once for each task parameter that needs to be defined.Furthermore, the
--task-param/-tp,--tasks, and--maximum-tasksoptions have been made mutually exclusive.What is the impact of this change?
A, hopefully, more intuitive interface.
How was this change tested?
I've run it locally as well as updated & added unit tests.
Was this change documented?
Yes, in the README.
Is this a breaking change?
Yes, the CLI options have changed.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.