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.

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

x/build/cmd/relui, x/build/internal/workflow: come up with a mechanism for richer parameter metadata #51191

Closed
dmitshur opened this issue Feb 14, 2022 · 2 comments
Closed

x/build/cmd/relui, x/build/internal/workflow: come up with a mechanism for richer parameter metadata #51191

dmitshur opened this issue Feb 14, 2022 · 2 comments
Labels
Builders x/build issues (builders, bots, dashboards) FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
Go Release Team
Milestone
Unreleased

Comments

@dmitshur
Copy link
Contributor

Right now workflow parameters have a name, and always have type string.

workflow.Definition.ParameterNames() returns a slice of parameter names, which is sufficient to describe parameters today.

However, we may want to have additional metadata for parameters. For example:

  • validation (at minimum, whether the zero value is allowed or not)
  • documentation, sample values (might be part of doc)
  • placeholder value
  • parameter type (string, string slice, ...)

This is the tracking issue for this work.

CC @golang/release.
@dmitshur dmitshur added Builders x/build issues (builders, bots, dashboards) NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Feb 14, 2022
@dmitshur dmitshur added this to the Unreleased milestone Feb 14, 2022
@dmitshur
Copy link
Contributor Author

dmitshur commented Apr 5, 2022

From a workflow's perspective, a parameter can be of type []string, but from relui's web UI perspective it can be a "0 or more large text areas" or "0 or more short single-line text boxes".

This suggests relui should make for a better place for storing such parameter metadata, as long as it doesn't get too much in the way of workflow self-description requirements.

@dmitshur dmitshur self-assigned this Apr 22, 2022
@dmitshur dmitshur added this to In Progress in Go Release Team Apr 22, 2022
@gopherbot
Copy link

Change https://go.dev/cl/404454 mentions this issue: internal/relui, internal/workflow: add parameter type support

@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels May 5, 2022
Go Release Team automation moved this from In Progress to Done May 11, 2022
@dmitshur dmitshur mentioned this issue Aug 10, 2022
Closed
@golang golang locked and limited conversation to collaborators Jun 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Builders x/build issues (builders, bots, dashboards) FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
Go Release
Archived in project
Go Release Team
Done
Milestone
Unreleased
Development

No branches or pull requests
2 participants
@dmitshur @gopherbot