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

when expressions with array results (doc and example) #6092

Merged
merged 1 commit into from
Feb 6, 2023

Conversation

pritidesai
Copy link
Member

@pritidesai pritidesai commented Jan 31, 2023

Changes

Adding an example showcasing the usage of array results in when expressions, including indexing into an array results and array results with star notation. This usage includes both input and values components of when expressions.

Also, added doc with explicit syntax for input and values.

This is for the preparation of a potential promotion of #5688.

Signed-off-by: pritidesai pdesai@us.ibm.com

/kind documentation

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
  • 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
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Doc update for - How to refer to an array result in when expressions?

@tekton-robot tekton-robot added kind/documentation Categorizes issue or PR as related to documentation. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Jan 31, 2023
@tekton-robot tekton-robot requested review from abayer and jerop January 31, 2023 19:55
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 31, 2023
@pritidesai
Copy link
Member Author

Hey @jerop, here are the changes (doc and example) for showcasing how to refer to array results in when expressions as promised in #6055 (comment), PTAL, thanks!

Adding an example showcasing the usage of array results in when expressions,
including indexing into array results and array results with star notation.
This usage includes both `input` and `values` components of when expressions.

Also, added doc with syntax of these components.

Signed-off-by: pritidesai <pdesai@us.ibm.com>
@pritidesai pritidesai force-pushed the when-with-array-results branch from 130fd51 to 7cf648a Compare February 2, 2023 23:53
@tekton-robot
Copy link
Collaborator

The following Tekton test failed:

Test name Commit Details Required Rerun command
check-pr-has-kind-label 130fd51 link true /test check-pr-has-kind-label

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

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

thanks @pritidesai

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

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 Feb 3, 2023
@pritidesai pritidesai added this to the Pipelines v0.45 milestone Feb 3, 2023
@Yongxuanzhang
Copy link
Member

/lgtm
Thanks! The example covers the use cases and it's a great example for me to learn!

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 6, 2023
@tekton-robot tekton-robot merged commit bd6a12f into tektoncd:main Feb 6, 2023
@pritidesai pritidesai deleted the when-with-array-results branch February 6, 2023 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants