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

Deduplicate examples tests between v1 and v1beta1 #6908

Merged
merged 1 commit into from
Jul 21, 2023

Conversation

lbernick
Copy link
Member

@lbernick lbernick commented Jul 7, 2023

Currently, we run a large number of examples tests that are duplicated in v1 and v1beta1. These tests are meant to test specific features, such as params and workspaces, that have the same syntax and implementation in v1 and v1beta1. Since we have conversion integration tests, these duplicated examples tests are likely adding little value.

In addition, examples tests are the flakiest set of tests in the repo and often time out. Removing redundant examples tests should make our CI less flaky.

This commit moves any examples tests that were solely present in v1beta1 to v1, leaving only those that use features that weren't migrated to v1. It deletes any examples that were duplicated between v1 and v1beta1.

/kind cleanup
Partially addresses #6906

Submitter Checklist

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

  • n/a Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • n/a 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). See some examples of good release notes.
  • n/a Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Jul 7, 2023
@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jul 7, 2023
@lbernick lbernick force-pushed the remove-examples branch 3 times, most recently from 8584a51 to a9be783 Compare July 7, 2023 15:23
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.

examples are not only used for tests but also as samples for users (with some of them even being referenced in the docs) -- instead of removing them, can we move them to the folder where they are not tested so that they can still be used as samples? the concern here though is that they may go out of date if they are not tested :/

@jerop
Copy link
Member

jerop commented Jul 7, 2023

reading the description of this PR again, you are not actually removing any tests because there are integration tests for the same functionality, you are only deduplicating v1 and v1beta1 -- is that correct? if so, I suggest updating the title to "deduplicate example tests in v1beta1 and v1"

reading #6906 and the title made me think that you were actually removing tests -- thought the redundancy is with integration tests

please clarify

@lbernick lbernick changed the title Remove redundant examples tests Deduplicate examples tests between v1 and v1beta1 Jul 7, 2023
@lbernick
Copy link
Member Author

lbernick commented Jul 7, 2023

Thanks for the feedback, updated the PR title and commit message!

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

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 Jul 11, 2023
@Yongxuanzhang
Copy link
Member

/lgtm

Thanks! Not sure if in docs we linked to examples moved in this PR, but should be easy to fix if there is any

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 21, 2023
@lbernick lbernick closed this Jul 21, 2023
@lbernick lbernick reopened this Jul 21, 2023
Currently, we run a large number of examples tests that are duplicated
in v1 and v1beta1. These tests are meant to test specific features,
such as params and workspaces, that have the same syntax and implementation
in v1 and v1beta1. Since we have conversion integration tests, these
duplicated examples tests are likely adding little value.

In addition, examples tests are the flakiest set of tests in the repo
and often time out. Removing redundant examples tests should make our CI
less flaky.

This commit moves any examples tests that were solely present in v1beta1 to v1,
leaving only those that use features that weren't migrated to v1.
It deletes any examples that were duplicated between v1 and v1beta1.
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 21, 2023
@Yongxuanzhang
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 21, 2023
@tekton-robot tekton-robot merged commit 2247ef3 into tektoncd:main Jul 21, 2023
HamzaMateen added a commit to HamzaMateen/pipeline that referenced this pull request Aug 12, 2023
In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1,
this commit addresses broken links in our documentation. The changes involve updating
references to examples under the v1beta1 API version to instead point to the v1 API version.
Additionally, certain features that transitioned from alpha to beta within the v1 API required
corresponding updates to their references.

This change ensures that the documentation accurately reflects the current state of the project,
eliminating broken links and inconsistencies. The goal is to improve the overall user experience
and provide accurate information.

Fixes tektoncd#6908
tekton-robot pushed a commit that referenced this pull request Aug 15, 2023
In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1,
this commit addresses broken links in our documentation. The changes involve updating
references to examples under the v1beta1 API version to instead point to the v1 API version.
Additionally, certain features that transitioned from alpha to beta within the v1 API required
corresponding updates to their references.

This change ensures that the documentation accurately reflects the current state of the project,
eliminating broken links and inconsistencies. The goal is to improve the overall user experience
and provide accurate information.

Fixes #6908
tekton-robot pushed a commit to tekton-robot/pipeline that referenced this pull request Oct 11, 2023
In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1,
this commit addresses broken links in our documentation. The changes involve updating
references to examples under the v1beta1 API version to instead point to the v1 API version.
Additionally, certain features that transitioned from alpha to beta within the v1 API required
corresponding updates to their references.

This change ensures that the documentation accurately reflects the current state of the project,
eliminating broken links and inconsistencies. The goal is to improve the overall user experience
and provide accurate information.

Fixes tektoncd#6908
tekton-robot pushed a commit that referenced this pull request Oct 11, 2023
In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1,
this commit addresses broken links in our documentation. The changes involve updating
references to examples under the v1beta1 API version to instead point to the v1 API version.
Additionally, certain features that transitioned from alpha to beta within the v1 API required
corresponding updates to their references.

This change ensures that the documentation accurately reflects the current state of the project,
eliminating broken links and inconsistencies. The goal is to improve the overall user experience
and provide accurate information.

Fixes #6908
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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. 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.

5 participants