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

docs: optimize examples for propagating results #7554

Merged
merged 1 commit into from
Feb 26, 2024
Merged

docs: optimize examples for propagating results #7554

merged 1 commit into from
Feb 26, 2024

Conversation

l-qing
Copy link
Contributor

@l-qing l-qing commented Jan 10, 2024 •
edited
Loading

The previous example did not actually output results, leading to the misconception that it was not effective.

Changes

Submitter Checklist

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

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • 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). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

/kind documentation

@tekton-robot tekton-robot added kind/documentation Categorizes issue or PR as related to documentation. 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. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 10, 2024
@tekton-robot
Copy link
Collaborator

Hi @l-qing. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 l-qing force-pushed the docs/optimize-results-propagation-examples branch from e98fecb to 0cd4951 Compare January 10, 2024 08:09
@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 10, 2024
l-qing
l-qing commented Jan 10, 2024
View reviewed changes
docs/pipelineruns.md
- echo
# - $(params.uid)
- $(tasks.add-uid.results.uid)
- echo $(tasks.add-uid.results.uid)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The previous method, although it would replace with specific values, could not be outputted by echo, leading to the misconception that it was not effective.

@vdemeester
Copy link
Member

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 10, 2024
@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 Jan 11, 2024
@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch 6 times, most recently from a3fd918 to 597c4d2 Compare January 23, 2024 10:16
@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch 3 times, most recently from de369f6 to 813c06d Compare January 31, 2024 06:01
@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch 3 times, most recently from bb24bbc to 486f29b Compare February 10, 2024 13:43
@l-qing
Copy link
Contributor Author

l-qing commented Feb 10, 2024

/test pull-tekton-pipeline-integration-tests

@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch from 486f29b to 600ea53 Compare February 12, 2024 01:22
@l-qing
Copy link
Contributor Author

l-qing commented Feb 12, 2024

/retest-required

@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch 4 times, most recently from 092b293 to ed801f7 Compare February 17, 2024 01:07
@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch from ed801f7 to a87f113 Compare February 21, 2024 14:19
@l-qing
docs: optimize examples for propagating results
4230a40 
The previous example did not actually output results,
leading to the misconception that it was not effective.
@l-qing l-qing force-pushed the docs/optimize-results-propagation-examples branch from a87f113 to 4230a40 Compare February 22, 2024 10:33
@l-qing
Copy link
Contributor Author

l-qing commented Feb 22, 2024

/cc @JeromeJu

Could you please take a look at this PR?
It's also related to documentation.
It's been created for over a month now. 😆

afrittoli
afrittoli reviewed Feb 26, 2024
View reviewed changes
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thanks @l-qing
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 26, 2024
@tekton-robot tekton-robot merged commit 302b382 into tektoncd:main Feb 26, 2024
11 checks passed
@l-qing l-qing deleted the docs/optimize-results-propagation-examples branch February 26, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afrittoli afrittoli afrittoli left review comments

@dibyom dibyom dibyom approved these changes

@abayer abayer Awaiting requested review from abayer

@pritidesai pritidesai Awaiting requested review from pritidesai

@JeromeJu JeromeJu Awaiting requested review from JeromeJu

Assignees

@afrittoli afrittoli

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

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