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

Create testdata sample for samples in the reference links #3974

Open
camilamacedo86 opened this issue Jun 10, 2024 · 4 comments
Open

Create testdata sample for samples in the reference links #3974

camilamacedo86 opened this issue Jun 10, 2024 · 4 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@camilamacedo86
Copy link
Member

What do you want to happen?

Context:

In the hack/ dir we have a code that generate the samples and then add the code on top of this, see:

Problem that we want to solve

The code under references in the docs are not in samples generate with real projects which means they are not tested and can easily get outdated.

How we want to solve

We would like to have a sample testdata that is generated and we can use the code.
We might could have a controller-per reference instead of one project for each reference.

ALso, by doing that we can test out the sample for each PR which will help us out ensure that all still valid when we update and move forward.

Example: See https://kubebuilder.io/reference/watching-resources/externally-managed

This sample could be in a project and we could indeed test it out with e2e tests.

Extra Labels

No response

@camilamacedo86 camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 10, 2024
@camilamacedo86 camilamacedo86 changed the title Create testdata sample with the code of references Create testdata sample for samples in the reference links Jun 10, 2024
@camilamacedo86 camilamacedo86 added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. labels Jun 10, 2024
@BalaadityaPatanjali
Copy link

I would like to work on this !

@lohitslohit
Copy link

@BalaadityaPatanjali Are you working on this issue?

@BalaadityaPatanjali
Copy link

@BalaadityaPatanjali Are you working on this issue?

No, you can work on it !

@lohitslohit
Copy link

okay @BalaadityaPatanjali

@BalaadityaPatanjali Are you working on this issue?

No, you can work on it !

@camilamacedo86 camilamacedo86 removed the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

3 participants