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

Clarify ParamValue syntax #6445

Merged
merged 1 commit into from
Apr 4, 2023
Merged

Clarify ParamValue syntax #6445

merged 1 commit into from
Apr 4, 2023

Conversation

lbernick
Copy link
Member

This commit updates the API spec docs to clarify that ParamValues can be strings, lists of strings, and maps of string to string. Since we use a custom unmarshaling function, the user-specified syntax doesn't actually contain the fields "type", "stringVal", "arrayVal", and "objectVal".

This commit also removes the JSON struct tags for this field, which serve no functional purpose. This helps clarify that param values undergo custom unmarshalling.

More investigation is needed to determine how to correctly display this field in autogenerated OpenAPI docs. This will happen in a later commit.

Partially addresses #6365
/kind cleanup

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • n/a Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • n/a Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • n/a Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 28, 2023
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 28, 2023
dibyom
dibyom approved these changes Mar 29, 2023
View reviewed changes
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

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

This LGTM though like you mentioned the autogenerated docs still showing the 3 fields as required is not ideal

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 29, 2023
@lbernick lbernick requested review from Yongxuanzhang and removed request for bobcatfish April 3, 2023 14:37
@Yongxuanzhang
Copy link
Member

/lgtm

Thanks!

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2023
@lbernick lbernick closed this Apr 3, 2023
@lbernick lbernick reopened this Apr 3, 2023
@lbernick
Clarify ParamValue syntax
e3f3002 
This commit updates the API spec docs to clarify that ParamValues can be
strings, lists of strings, and maps of string to string. Since we use a custom
unmarshaling function, the user-specified syntax doesn't actually contain the fields
"type", "stringVal", "arrayVal", and "objectVal".

This commit also removes the JSON struct tags for this field, which serve no functional
purpose. This helps clarify that param values undergo custom unmarshalling.

More investigation is needed to determine how to correctly display this field in
autogenerated OpenAPI docs. This will happen in a later commit.
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2023
Yongxuanzhang
Yongxuanzhang reviewed Apr 3, 2023
View reviewed changes
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2023
@l-qing
Copy link
Contributor

l-qing commented Apr 4, 2023

/test pull-tekton-pipeline-go-coverage-df

@tekton-robot
Copy link
Collaborator

@l-qing: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-beta-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test pull-tekton-pipeline-go-coverage-df

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@l-qing
Copy link
Contributor

l-qing commented Apr 4, 2023

/test pull-tekton-pipeline-go-coverage

@tekton-robot tekton-robot merged commit 428166c into tektoncd:main Apr 4, 2023
@Yongxuanzhang Yongxuanzhang mentioned this pull request May 5, 2023
Closed
7 tasks
@pritidesai pritidesai mentioned this pull request Jul 13, 2023
Closed
@afrittoli afrittoli mentioned this pull request Jul 14, 2023
Closed
l-qing added a commit to katanomi/pipeline that referenced this pull request Jan 17, 2024
@l-qing
chore: let controller-gen can generate crds correctly
ece5d77 
revert some changes from tektoncd#6445
l-qing added a commit to katanomi/pipeline that referenced this pull request Jan 17, 2024
@l-qing
chore: let controller-gen can generate crds correctly
315d68a 
revert some changes from tektoncd#6445
@l-qing l-qing mentioned this pull request Jan 17, 2024
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yongxuanzhang Yongxuanzhang Yongxuanzhang left review comments

@dibyom dibyom dibyom approved these changes

Assignees

@dibyom dibyom

@Yongxuanzhang Yongxuanzhang

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lbernick @tekton-robot @Yongxuanzhang @l-qing @dibyom