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

Add long flag --display-name to display the log of pipelinerun #2450

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

icloudnote
Copy link

@icloudnote icloudnote commented Dec 20, 2024

Changes

Add a new long flag --display-name to show pipelinerun logs, when --display-name=true , show logs with task display name.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Run the code checkers with make check
  • Regenerate the manpages, docs and go formatting with make generated
  • Commit messages follow commit message best practices

See the contribution guide
for more details.

Release Notes

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Dec 20, 2024
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign pradeepitm12 after the PR has been reviewed.
You can assign the PR to them by writing /assign @pradeepitm12 in a comment when ready.

The full list of commands accepted by this bot can be found 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

Copy link

linux-foundation-easycla bot commented Dec 20, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: icloudnote / name: changjun zhao (de8e888)

@tekton-robot tekton-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 20, 2024
@tekton-robot
Copy link
Contributor

Hi @icloudnote. 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.

@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Dec 20, 2024
@chmouel
Copy link
Member

chmouel commented Dec 20, 2024

I am afraid this may be breaking people that rely on that output...

@chmouel
Copy link
Member

chmouel commented Dec 20, 2024

maybe a flag like --long to display more info and have the displayname into it?

@icloudnote
Copy link
Author

maybe a flag like --long to display more info and have the displayname into it?

good idea

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 21, 2024
@icloudnote icloudnote changed the title Fix log prefix display inconsistency Add long flag --display-name to display the log of pipelinerun Dec 21, 2024
@icloudnote
Copy link
Author

/ok-to-test

@tekton-robot
Copy link
Contributor

@icloudnote: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/ok-to-test

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.

@tekton-robot tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 21, 2024
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 21, 2024
@icloudnote
Copy link
Author

Add a new long flag --display-name to show pipelinerun logs, when --display-name=true , show logs with task display name.

I have add new flag --display-name to show pipelinerun logs.

@pratap0007
Copy link
Contributor

/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 2, 2025
@chmouel
Copy link
Member

chmouel commented Jan 2, 2025

what do you think about --long instead as we can add more verbose output in the future and not necessary have to add a flag for every kind of detailed output

@icloudnote
Copy link
Author

what do you think about --long instead as we can add more verbose output in the future and not necessary have to add a flag for every kind of detailed output

For more detailed output, I personally feel that it may not be a good idea to put it in the prefix. After all, prefixes are often used to quickly locate problems and query logs of related steps. The format of [task_name, step_name] is sufficient.

The log format of using the [display_name: step_name] prefix is ​​also to make the log look more concise and locate problems more quickly. It is bad that pipeline run does not display Display_Name, but Tekton Dashboard displays Display_Name, which looks very good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants