cli
cli copied to clipboard
tektoncd
UX: unify the use of grammatical number for logs and showlog
Version and Operating System
tkn Version:
0.7.1
Operating System:
Expected Behavior
The same concept is named in the same way
Actual Behavior
Multiple commands have a subcommand logs (plural, e.g. tkn task -h) but subcommand start has a parameter --showlog (singular, e.g. tkn task start -h) which is not user-friendly.
Steps to Reproduce the Problem
Additional Info
Hey @ppitonak
We support tkn task logs and tkn taskrun logs. --showlog is for immediately starting logs after starting a PipelineRun or TaskRun. Are you suggesting that you would like this to be named --logs instead, or just that you would like it to be --showlogs?
Thanks for your issue , renaming flag is not cheap, as users (+ scripts) may have already using it in the a released version , why do you feel so strong that plural would be more user friendly than singular word ?
It's my personal preference for --showlogs instead of --showlog but my point is that is should be either singular or plural everywhere.
Is renaming tkn task logs to tkn task log easier?
You can always introduce new one and deprecate the old one (without removing it). IMHO these changes are acceptable while the API is alpha, would be much more difficult when we go beta.
renaming may only occurs over a long period of time deprecation over multiple release, but we could provide an alias if that's something a lot of users are asking.. as you know naming is hard and sometime it's better to just "live with it"
You could always have an alias like tktn_logs if that really something that you need ?
In general, supporting a log alias for logs subcommands would be really nice.
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
/lifecycle stale
Send feedback to tektoncd/plumbing.
Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close.
/lifecycle rotten
Send feedback to tektoncd/plumbing.
Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.
/close
Send feedback to tektoncd/plumbing.
@tekton-robot: Closing this issue.
In response to this:
Rotten issues close after 30d of inactivity. Reopen the issue with
/reopen. Mark the issue as fresh with/remove-lifecycle rotten./close
Send feedback to tektoncd/plumbing.
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.
@ppitonak: Reopened this issue.
In response to this:
/reopen
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.
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
/lifecycle stale
Send feedback to tektoncd/plumbing.
Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.
/lifecycle rotten
Send feedback to tektoncd/plumbing.
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.
/lifecycle stale
Send feedback to tektoncd/plumbing.
Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.
/lifecycle rotten
Send feedback to tektoncd/plumbing.