-
Notifications
You must be signed in to change notification settings - Fork 41
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.
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
Workflow parameters #159
Merged
Merged
Workflow parameters #159
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
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.
This PR adds workflow parameters, a way to parametrize workflows in a way that makes the branch lookup dynamic, based on values in the branch map.
From the README:
Example code:
option_a
andoption_b
arelaw.WorkflowParameter
s that can optionally define acls
(orinst
) of a other parameter object that is used for parameter parsing and serialization (as always).create_branch_map
becomes a@classmethod
and receives all task parameters in a dictionary params.This is necessary since the automatic lookup of branches based on the values of workflow parameters, internally, must happen before the task is actually instantiated.
As a result, parameters can be defined verbosely on the command line, translate to branch values, and configure which branches are run by the workflow:
--option-a foo --option-b 123
→ findsbranch=0
(but for this, you probably wouldn't need a workflow in the first place)--option-a foo
→ findsbranches=[0, 2]
and runs them as a workflow--option-b 456
→ findsbranches=[1, 2]
and runs them as a workflow--option-b 123
→ findsbranches=[0]
and runs it in a workflow; in particular, this is not a branch as--option-a
is not specified, meaning we're "not interested in any particular value of option_a, just run all that are found".Closes #131, #137.