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

Jump to bottom

fix: update reusable workflow input handling #2349

Merged
merged 3 commits into from
Jun 5, 2024
Merged

fix: update reusable workflow input handling #2349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f52368
update reusable workflow input handling
ChristopherHX Jun 3, 2024
a948224
make test stricter
ChristopherHX Jun 4, 2024
a970b77
Merge branch 'master' into update-reusable-workflow-inputs
mergify[bot] Jun 5, 2024
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
8 changes: 4 additions & 4 deletions pkg/model/workflow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,10 @@ func (w *Workflow) WorkflowDispatchConfig() *WorkflowDispatch {
}

type WorkflowCallInput struct {
Description string `yaml:"description"`
Required bool `yaml:"required"`
Default string `yaml:"default"`
Type string `yaml:"type"`
Description string `yaml:"description"`
Required bool `yaml:"required"`
Default yaml.Node `yaml:"default"`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preserve the original type

Type string `yaml:"type"`
}

type WorkflowCallOutput struct {
Expand Down
19 changes: 11 additions & 8 deletions pkg/runner/expression.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ func getEvaluatorInputs(ctx context.Context, rc *RunContext, step step, ghc *mod
for k, v := range config.Inputs {
value := nestedMapLookup(ghc.Event, "inputs", k)
if value == nil {
value = v.Default
v.Default.Decode(&value)
}
if v.Type == "boolean" {
inputs[k] = value == "true"
Expand All @@ -531,21 +531,24 @@ func setupWorkflowInputs(ctx context.Context, inputs *map[string]interface{}, rc

for name, input := range config.Inputs {
value := rc.caller.runContext.Run.Job().With[name]

if value != nil {
if str, ok := value.(string); ok {
node := yaml.Node{}
_ = node.Encode(value)
if rc.caller.runContext.ExprEval != nil {
// evaluate using the calling RunContext (outside)
value = rc.caller.runContext.ExprEval.Interpolate(ctx, str)
_ = rc.caller.runContext.ExprEval.EvaluateYamlNode(ctx, &node)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expressions can return boolean and number types for parameters so EvaluateYamlNode can do it better than the typeless Interpolate

}
_ = node.Decode(&value)
}

if value == nil && config != nil && config.Inputs != nil {
value = input.Default
def := input.Default
if rc.ExprEval != nil {
if str, ok := value.(string); ok {
// evaluate using the called RunContext (inside)
value = rc.ExprEval.Interpolate(ctx, str)
}
// evaluate using the called RunContext (inside)
_ = rc.ExprEval.EvaluateYamlNode(ctx, &def)
}
_ = def.Decode(&value)
}

(*inputs)[name] = value
Expand Down
16 changes: 8 additions & 8 deletions pkg/runner/testdata/.github/workflows/local-reusable-workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,23 @@ jobs:

- name: test required bool
run: |
echo inputs.bool_required=${{ inputs.bool_required }}
[[ "${{ inputs.bool_required }}" = "true" ]] || exit 1
echo inputs.bool_required=${{ tojson(inputs.bool_required) }}
[[ "${{ tojson(inputs.bool_required) }}" = "true" ]] || exit 1

- name: test optional bool
run: |
echo inputs.bool_optional=${{ inputs.bool_optional }}
[[ "${{ inputs.bool_optional }}" = "true" ]] || exit 1
echo inputs.bool_optional=${{ tojson(inputs.bool_optional) }}
[[ "${{ tojson(inputs.bool_optional) }}" = "true" ]] || exit 1

- name: test required number
run: |
echo inputs.number_required=${{ inputs.number_required }}
[[ "${{ inputs.number_required == 1 }}" = "true" ]] || exit 1
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tojson force string equal, to avoid any possible automatic type conversion

echo inputs.number_required=${{ tojson(inputs.number_required) }}
[[ "${{ tojson(inputs.number_required) == '1' }}" = "true" ]] || exit 1

- name: test optional number
run: |
echo inputs.number_optional=${{ inputs.number_optional }}
[[ "${{ inputs.number_optional == 1 }}" = "true" ]] || exit 1
echo inputs.number_optional=${{ tojson(inputs.number_optional) }}
[[ "${{ tojson(inputs.number_optional) == '1' }}" = "true" ]] || exit 1

- name: test secret
run: |
Expand Down
Loading