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

TEP-0142: Introduce Params and Results into StepActions CRD #7317

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

chitrangpatel
Copy link
Member

@chitrangpatel chitrangpatel commented Oct 31, 2023

This PR introduces params and results into the StepAction CRD. It allows the StepAction to declare the params it needs and the results it will produce.
The follow up PRs will contain the interaction of how a Task referencing the StepAction resolves them.

All the tests were borrowed from pkg/apis/pipeline/v1/... that overlapped with paramSpec and Results.

Changes

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

[WIP] Introduces params and results into the StepAction CRD.

/kind feature

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. labels Oct 31, 2023
@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 31, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@chitrangpatel chitrangpatel force-pushed the step-actions-results-crd branch 2 times, most recently from 4757779 to 66c61e7 Compare October 31, 2023 18:22
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/param_types.go Do not exist 98.5%
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 99.1% 6.8

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Yongxuanzhang

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

The pull request process is described 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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 1, 2023
@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 2, 2023
@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 2, 2023
@chitrangpatel chitrangpatel force-pushed the step-actions-results-crd branch 3 times, most recently from 30d58c8 to 44f3368 Compare November 2, 2023 16:33
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 2, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 98.7% 6.4

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 98.7% 6.4

This PR introduces `params` and `results` into the `StepAction` CRD.
It allows the `StepAction` to declare the params it needs and the
results it will produce.
The follow up PRs will contain the interaction of how a `Task` referencing
the `StepAction` resolves them.

All the tests were borrowed from `pkg/apis/pipeline/v1/...` that
overlapped with `paramSpec` and `Results`.
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 98.7% 6.4

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/result_types.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/result_validation.go Do not exist 94.4%
pkg/apis/pipeline/v1alpha1/stepaction_defaults.go Do not exist 100.0%
pkg/apis/pipeline/v1alpha1/stepaction_validation.go 92.3% 98.7% 6.4

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

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

/unhold
/lgtm

@tekton-robot tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 3, 2023
@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 3, 2023
@tekton-robot tekton-robot merged commit 695311e into tektoncd:main Nov 3, 2023
12 checks passed
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 3, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 3, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 3, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 6, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 6, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This PR adds the necessary syntax to `Steps` to pass `params` to `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 6, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This PR adds the necessary syntax to `Steps` to pass `params` to `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 6, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 6, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This PR adds the necessary syntax to `Steps` to pass `params` to `StepActions`. This work is part of
issue tektoncd#7259.
tekton-robot pushed a commit that referenced this pull request Nov 7, 2023
Following the previous [PR](#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This PR adds the necessary syntax to `Steps` to pass `params` to `StepActions`. This work is part of
issue #7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 8, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 8, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 8, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 8, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 8, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
chitrangpatel added a commit to chitrangpatel/pipeline that referenced this pull request Nov 9, 2023
Following the previous [PR](tektoncd#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue tektoncd#7259.
tekton-robot pushed a commit that referenced this pull request Nov 9, 2023
Following the previous [PR](#7317), which introduced Params to the `StepAction` CRD,
this PR integrates `param` usage between `Steps` and `StepActions`. This
completes support for params in `StepActions`. This work is part of
issue #7259.
@jerop jerop added this to the Pipelines v0.54 milestone Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants