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

add docs for emitting object results #7120

Merged
merged 1 commit into from
Sep 19, 2023
Merged

add docs for emitting object results #7120

merged 1 commit into from
Sep 19, 2023

Conversation

Yongxuanzhang
Copy link
Member

@Yongxuanzhang Yongxuanzhang commented Sep 15, 2023 •
edited
Loading

Changes

Add instructions on how to define and emit object results.

Signed-off-by: Yongxuan Zhang [email protected]

/kind documentation

closes #7106

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

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 15, 2023
@Yongxuanzhang
Copy link
Member Author

/retest

lbernick
lbernick approved these changes Sep 18, 2023
View reviewed changes
docs/tasks.md
You will need to use escaped JSON to write to pod termination message:

```
{\"url\":\"abc.dev/sampler\",\"digest\":\"19f02276bf8dbdd62f069b922f10c65262cc34b710eea26ff928129a736be791\"}
Copy link
Member

Choose a reason for hiding this comment

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

it might be helpful to have the example with the task spec first. Having the JSON alone makes it a bit confusing how the JSON goes into the spec.

Copy link
Member Author

Choose a reason for hiding this comment

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

There is a full example right after this, the same as array result section, so I think it should be fine?

docs/tasks.md Outdated Show resolved Hide resolved
docs/tasks.md
{"url":"abc.dev/sampler","digest":"19f02276bf8dbdd62f069b922f10c65262cc34b710eea26ff928129a736be791"}
```

You will need to use escaped JSON to write to pod termination message:
Copy link
Member

Choose a reason for hiding this comment

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

Is this also true for "args" instead of "script"?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's a good question! Results are usually emitted in script, I'm not sure if emitting from args is a valid use case since

Copy link
Member Author

Choose a reason for hiding this comment

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

So I'm not sure about the args, I tried to emit from args but not able to make it work in a short time. Maybe we can leave as is

docs/tasks.md Outdated Show resolved Hide resolved
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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 Sep 18, 2023
@jerop jerop added this to the Pipelines v0.52 milestone Sep 18, 2023
@Yongxuanzhang
add docs for emitting object results
3dc44ab 
Add instructions on how to define and emit object results.

Signed-off-by: Yongxuan Zhang [email protected]
jerop
jerop reviewed Sep 19, 2023
View reviewed changes
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.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 19, 2023
@jerop
Copy link
Member

jerop commented Sep 19, 2023

/test pull-tekton-pipeline-build-tests

@tekton-robot tekton-robot merged commit 5131016 into tektoncd:main Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jerop jerop jerop left review comments

@lbernick lbernick lbernick approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@vdemeester vdemeester Awaiting requested review from vdemeester

Assignees

@jerop jerop

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-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
Pipelines v0.52
Development

Successfully merging this pull request may close these issues.

Add documentation for object Results
4 participants
@Yongxuanzhang @tekton-robot @jerop @lbernick