Uploaded image for project: 'OpenShift Pipelines'
  1. OpenShift Pipelines
  2. SRVKP-8093

tkn-results - indicate when there are more runs than listed

XMLWordPrintable

      Story (Required)

      As a user trying to list pipelineruns using `tkn-results` I want know if there are more results than the CLI is listing.

      I want concise output, but I also don't want information hidden.

      Background (Required)

      Currently when you list PipelineRuns or TaskRuns using `tkn-results taskrun list` it defaults to using the flag --single-page. This is useful for ensuring the list of items is not overwhelmingly large. However there is no indication that there are more items which are not being listed. If the user does now know or remember that -single-page is used by default, they would reasonably assume from the output that there are no additional taskRuns or PLRs except those listed.

      Out of scope

      <Defines what is not included in this story>

      Approach (Required)

      Some trailer indicating that more Runs exist but are not listed would be useful- it doesn't change the expected behavior but helps the user have a better understanding of the output. For example (there may be better indicators):

      $ kubectl tkn results pipelinerun list
      NAME                                             UID                                    STARTED    DURATION   STATUS
      pipelinerun-write-and-read-array-results-hjk57   6d6376cb-2878-4905-ae11-a147eae90674   80d ago    1s         Failed
      test-pipelinerun-5np8f                           4f7b8541-e936-41c1-87cb-627f0abff4d4   139d ago   12s        Succeeded
      pipelinerun-with-extra-paramssd999               38dcc75b-3ddb-43bb-b0cd-048a8bd9ae67   191d ago   0s         Failed
      pipelinerun-object-results-nt4d9                 91539551-63f7-480e-b77a-abc0aee81788   191d ago   0s         Failed
      demo-pipeline-run-1                              2c1a88fb-0aff-4a4e-b187-dcec005271c7   191d ago   1m28s      Failed
      [...] Some items items not shown. Use --limit to change the number of items listed
       

       

       

      Dependencies

      <Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

      Acceptance Criteria (Mandatory)

      • When listing PipelineRuns or TaskRuns, it is evident to the user if/when there are more items than those in the output.

       

       

      INVEST Checklist

      Dependencies identified

      Blockers noted and expected delivery timelines set

      Design is implementable

      Acceptance criteria agreed upon

      Story estimated

      Legend

      Unknown

      Verified

      Unsatisfied

      Done Checklist

      • Code is completed, reviewed, documented and checked in
      • Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
      • Continuous Delivery pipeline(s) is able to proceed with new code included
      • Customer facing documentation, API docs etc. are produced/updated, reviewed and published
      • Acceptance criteria are met

              Unassigned Unassigned
              rh-ee-athorp Andrew Thorp
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: