tektoncd / dashboard

A dashboard for Tekton!
Apache License 2.0
863 stars 258 forks source link

Add StepActions to the Dashboard #3348

Closed chitrangpatel closed 2 weeks ago

chitrangpatel commented 4 months ago

Feature request

StepActions were released in Tekton Pipelines v0.54.0. It would be nice to view them in the Dashboard listing all the different CRDs.

Screenshot 2024-03-12 at 11 37 59 AM

Use case

Readability and quick access to the underlying StepAction Spec.

Alternatives

Additional context

chitrangpatel commented 4 months ago

/kind feature

AlanGreene commented 4 months ago

Thanks for the feature request @chitrangpatel. Adding a new link to show the StepActions resources should be relatively straightforward. Would there also be changes required on the PipelineRun or TaskRun details pages to show these or are they unaffected?

I see StepActions is still an alpha feature. Is there a timeline for when we expect them to be promoted to beta?

chitrangpatel commented 4 months ago

Hi @AlanGreene We would not require changes on the pipelineRun side.

On the TaskRun side, it would be nice to also list any StepActions if used in-line in the TaskRun's spec. It would be found under:

TaskRun:
spec:
  taskSpec:
    steps:
      - ref:
         name: <step-action-name>

On the other hand, it is also possible that the referenced Task in-turn references StepActions. In that case, we want to list them on the Task details page.

Task:
  spec:
    steps:
      - ref:
         name: stepaction-name

StepActions was released in 0.54.0. I think we need 6 months for review time before we can make it beta. I'm hoping to do that as soon as it's past the minimum time it needs to remain in alpha.

AlanGreene commented 4 months ago

OK so roughly v0.60.0 / June timeframe, or shortly after. Sounds good.

We'll need to test out some examples to see how they're reflected in the existing pages but hopefully there's not too much impact and we can provide something useful for users.

chitrangpatel commented 4 months ago

Yes, we already have a CI pipeline go-coverage-pipeline that uses StepActions.

AlanGreene commented 4 months ago

For my own reference that's https://dashboard.dogfooding.tekton.dev/#/pipelineruns?labelSelector=tekton.dev%2Fpipeline%3Dgo-coverage-pipeline

Looks like it's displayed correctly, or at least in the same way as a regular step with status, details, etc., so that's a good start 😌

I'll try to make some time in the next few weeks to explore this further and see what else we might need to do apart from updating the left nav.

AlanGreene commented 2 weeks ago

Support for displaying v1beta1 StepActions is now available in the latest nightly and will be included in this month's v0.49.0 release.