Skip to content

docs: document StepAction support in Hub Resolver#10275

Open
Ackberry wants to merge 1 commit into
tektoncd:mainfrom
Ackberry:feat/updateHubResolverDocs
Open

docs: document StepAction support in Hub Resolver#10275
Ackberry wants to merge 1 commit into
tektoncd:mainfrom
Ackberry:feat/updateHubResolverDocs

Conversation

@Ackberry

@Ackberry Ackberry commented Jun 14, 2026 •
edited
Loading

Copy link
Copy Markdown

Changes

Update docs/hub-resolver.md to:

  • list stepaction as a supported kind value
  • note that Artifact Hub StepAction packages use the tekton-stepaction package type
  • add a StepAction resolution example, matching the existing Task and Pipeline examples

Also note that, unlike task/pipeline, stepaction has no default catalog in resolveCatalogName, so catalog must be set explicitly.

Resolves #10202

update hub-resolver.md: add documentation for StepAction

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
  • pre-commit Passed
  • 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

@Ackberry
docs: document StepAction support in Hub Resolver
8c96289 
The Hub Resolver supports `stepaction` as a `kind` value
(see `supportedKinds` in pkg/resolution/resolver/hub/resolver.go),
but the docs only listed `task` and `pipeline`.

Update docs/hub-resolver.md to:
- list `stepaction` as a supported `kind` value
- note that Artifact Hub StepAction packages use the
  `tekton-stepaction` package type
- add a StepAction resolution example, matching the existing
  Task and Pipeline examples

Also note that, unlike `task`/`pipeline`, `stepaction` has no
default catalog in resolveCatalogName, so `catalog` must be set
explicitly.

Fixes tektoncd#10202
@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Jun 14, 2026
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jun 14, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: Ackberry / name: Ackberry (8c96289)

@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 14, 2026
@Ackberry

Ackberry commented Jun 14, 2026

Copy link
Copy Markdown
Author

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 14, 2026
@Ackberry

Ackberry commented Jun 15, 2026

Copy link
Copy Markdown
Author

/assign @vdemeester

@Ackberry

Ackberry commented Jun 15, 2026

Copy link
Copy Markdown
Author

Hello @vdemeester ! This is my first open source contribution in a major, active codebase. hope it is upto the standards. If not, happy to review and rewrite :)

@AlanGreene AlanGreene mentioned this pull request Jun 15, 2026
Closed
vdemeester
vdemeester approved these changes Jun 22, 2026
View reviewed changes

@vdemeester vdemeester left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

cc @twoGiants @waveywaves @afrittoli

Comment thread docs/hub-resolver.md
| Param Name | Description | Example Value |
|------------------|-------------------------------------------------------------------------------|------------------------------------------------------------|
| `catalog` | The catalog from where to pull the resource (Optional) | Default: `tekton-catalog-tasks` (for `task` kind); `tekton-catalog-pipelines` (for `pipeline` kind) |
| `catalog` | The catalog from where to pull the resource (Optional) | Default: `tekton-catalog-tasks` (for `task` kind); `tekton-catalog-pipelines` (for `pipeline` kind); no default for `stepaction` kind, so `catalog` must be set explicitly |

@vdemeester vdemeester Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Interesting for the step action, I wonder if, as a follow-up, we should have a default for stepaction 🤔

@chmouel chmouel Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

yeah that would be great, @copilot create an issue for this

@tekton-robot

tekton-robot commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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 Jun 22, 2026
@chmouel

chmouel commented Jun 22, 2026

Copy link
Copy Markdown
Member

/ok-to-test

@Ackberry

Ackberry commented Jun 27, 2026

Copy link
Copy Markdown
Author

Hello guys! Just wanted to bump this PR up. Was wondering if there's something that might be stopping from a merger.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vdemeester vdemeester vdemeester approved these changes
@dibyom dibyom Awaiting requested review from dibyom
@pritidesai pritidesai Awaiting requested review from pritidesai
+1 more reviewer
@chmouel chmouel chmouel left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@vdemeester vdemeester

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. 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

No milestone

Development

Successfully merging this pull request may close these issues.

docs: mention StepAction support in Hub Resolver docs

4 participants

@Ackberry @tekton-robot @chmouel @vdemeester