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-096 - Rename 'resources' to 'computeResources' in v1 taskRun #5493

Merged
merged 1 commit into from
Sep 26, 2022
Merged

TEP-096 - Rename 'resources' to 'computeResources' in v1 taskRun #5493

merged 1 commit into from
Sep 26, 2022

Conversation

JeromeJu
Copy link
Member

@JeromeJu JeromeJu commented Sep 13, 2022 •
edited
Loading

Changes

This commit renames taskRunStepOverride and taskRunSidecarOverride Golang structs to
taskRunStepSpec and taskRunSidecarSpec, renames taskrun.spec.stepOverrides and taskrun.spec.sidecarOverrides to taskrun.spec.stepSpecs and taskrun.spec.sidecarSpecs
and the fields related to compute resources in v1 to a standardized term computeResources.
This includes:

  • task.spec.steps[].resources
  • task.spec.stepTemplate.resources
  • task.spec.sidecars[].resources
  • taskRun.spec.stepOverrides[].resources
  • taskrun.spec.sidecarOverrides[].resources
  • taskRunStepOverride
  • taskRunSidecarOverride
    No functional changes.

Implements: TEP-096
/kind misc

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • 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
  • [n/a] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • [n/a] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Renames the `resources` to `computeResources` of `task.spec.steps[].resources`, `task.spec.stepTemplate.resources`, `task.spec.sidecars[].resources`, `taskRun.spec.stepOverrides[].resources`, `taskrun.spec.sidecarOverrides[].resources`. Renames `stepOverrides` and `sidecarOverrides` to `stepSpecs` and `sidecarSpecs`.

@tekton-robot tekton-robot added kind/misc Categorizes issue or PR as a miscellaneuous one. 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 Sep 13, 2022
@tekton-robot tekton-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. release-note-none Denotes a PR that doesnt merit a release note. 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 Sep 13, 2022
@JeromeJu
Copy link
Member Author

/kind misc

lbernick
lbernick reviewed Sep 14, 2022
View reviewed changes
Copy link
Member

@lbernick lbernick left a comment

Choose a reason for hiding this comment

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

Can you please also rename step overrides and sidecar overrides?

@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 14, 2022
@JeromeJu
Copy link
Member Author

/retest

@JeromeJu JeromeJu requested review from lbernick and removed request for bobcatfish and jerop September 14, 2022 17:23
@lbernick
Copy link
Member

stepOverrides and sidecarOverrides should be renamed to stepSpecs and sidecarSpecs, as detailed in tektoncd/community#798

@afrittoli
Copy link
Member

afrittoli commented Sep 14, 2022 •
edited
Loading

Thanks @JeromeJu - could you please add release notes?
I know v1 is not released yet, but I think it would good to have release notes still.

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed release-note-none Denotes a PR that doesnt merit a release note. labels Sep 15, 2022
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 15, 2022
@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 16, 2022
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 16, 2022
@JeromeJu JeromeJu force-pushed the rename-compute-resources branch 2 times, most recently from 15d5078 to 5a3b8ef Compare September 16, 2022 17:07
@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 19, 2022
@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 20, 2022
@jerop jerop self-assigned this Sep 20, 2022
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick, vdemeester

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 [lbernick,vdemeester]

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

jerop
jerop reviewed Sep 23, 2022
View reviewed changes
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.

@JeromeJu seems that the documentation needs to be updated 🤔

dev/docs/migrating-v1beta1-to-v1.md Outdated Show resolved Hide resolved
@JeromeJu
Rename 'resources' to 'computeResources' in v1 taskRun
ba35408 
This commit renames the `taskRunStepOverride` and `taskRunSidecarOverride` Golang structs to
`taskRunStepSpec` and `taskRunSidecarSpec`, renames `taskrun.spec.stepOverrides` and `taskrun.spec.sidecarOverrides`
to `taskrun.spec.stepSpecs` and `taskrun.spec.sidecarSpecs`, `pipelineRun.spec.taskRunSpecs.sidecarOverrides`
to `pipelineRun.spec.taskRunSpecs.sidecarSpecs`, `pipelineRun.spec.taskRunSpecs.stepOverrides` to
`pipelineRun.spec.taskRunSpecs.stepSpecs` and the fields related
to compute resources in v1 to a standardized term computeResources. This includes:
- task.spec.steps[].resources
- task.spec.stepTemplate.resources
- task.spec.sidecars[].resources
- taskRun.spec.stepSpecs[].resources
- taskrun.spec.sidecarSpecs[].resources
No functional changes.
@JeromeJu JeromeJu requested a review from jerop September 26, 2022 12:43
jerop
jerop reviewed Sep 26, 2022
View reviewed changes
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.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 26, 2022
@tekton-robot tekton-robot merged commit dd368a4 into tektoncd:main Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jerop jerop jerop left review comments

@lbernick lbernick lbernick approved these changes

@vdemeester vdemeester vdemeester approved these changes

Assignees

@jerop jerop

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. 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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@JeromeJu @lbernick @afrittoli @tekton-robot @vdemeester @jerop