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.

Sign up for GitHub

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

Jump to bottom

TEP-0142: param substitutions not allowed in StepAction's script #7549

Merged
merged 1 commit into from
Jan 16, 2024
Merged

TEP-0142: param substitutions not allowed in StepAction's script #7549

merged 1 commit into from
Jan 16, 2024

Conversation

chitrangpatel
Copy link
Contributor

@chitrangpatel chitrangpatel commented Jan 8, 2024 •
edited
Loading

Based on discussions in #7497 and consensus in the API WG, we disallow direct parameter substitution in scripts. While we cannot do this for inlined-steps since it is a major breaking change in v1, we can do this in Step Actions.

In this PR we add validation that params cannot be directly replaced in scripts of StepActions. Based on Issue #7497. The docs have been updated to inform this to the users and encourage the use of env vars in scripts instead.

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

Param substitutions not allowed directly in StepAction's script

/kind feature

@tekton-robot tekton-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Jan 8, 2024
@chitrangpatel chitrangpatel changed the title TEP-0142: param substitutions not allowed in StepAction script TEP-0142: param substitutions not allowed in StepAction's script Jan 8, 2024
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jan 8, 2024
@chitrangpatel
Copy link
Contributor Author

/assign @wlynch @vdemeester (based on discussions in API wg.)

@chitrangpatel
Copy link
Contributor Author

/kind feature

@tekton-robot tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Jan 8, 2024
@chitrangpatel
Copy link
Contributor Author

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

@chitrangpatel: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-beta-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test pull-tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

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.

@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/stepaction_validation.go 98.9% 98.9% 0.1

@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/stepaction_validation.go 98.9% 98.9% 0.1

@vdemeester
Copy link
Member 

 pkg/apis/pipeline/v1alpha1/stepaction_validation.go:79:24: S1002: should omit comparison to bool constant, can be simplified to `present` (gosimple)
	if errString != "" || present == true {

👼🏼

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 9, 2024
@chitrangpatel chitrangpatel added this to the Pipelines v0.56 milestone Jan 9, 2024
@chitrangpatel
TEP-0142: param substitutions not allowed in script
4231c8d 
Based on discussions in tektoncd#7497 and consensus in the API WG, we disallow direct parameter substitution in scripts. While we cannot do this for inlined-steps since it is a major breaking change in `v1`, we can do this in `Step Actions`.

In this PR we add validation that params cannot be directly replaced in `scripts` of `StepActions`.
@chitrangpatel chitrangpatel force-pushed the remove-params-in-scripts-step-actions branch from b7e9a67 to 4231c8d Compare January 9, 2024 17:52
@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/stepaction_validation.go 98.9% 98.9% 0.1

@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/stepaction_validation.go 98.9% 98.9% 0.1

@JeromeJu JeromeJu self-assigned this Jan 10, 2024
Yongxuanzhang
Yongxuanzhang approved these changes Jan 15, 2024
View reviewed changes
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

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

just one nit question, I can lgtm once it is answered

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester, 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:
  • OWNERS [Yongxuanzhang,vdemeester]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Yongxuanzhang
Yongxuanzhang reviewed Jan 16, 2024
View reviewed changes
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 16, 2024
@tekton-robot tekton-robot merged commit 47848a0 into tektoncd:main Jan 16, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yongxuanzhang Yongxuanzhang Yongxuanzhang approved these changes

@vdemeester vdemeester vdemeester approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@jerop jerop Awaiting requested review from jerop

Assignees

@Yongxuanzhang Yongxuanzhang

@JeromeJu JeromeJu

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
Pipelines v0.56
Development

Successfully merging this pull request may close these issues.
5 participants
@chitrangpatel @tekton-robot @vdemeester @Yongxuanzhang @JeromeJu