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 command for updating auto-generated docs and helm resources for CRD structs #1879

Open
2 tasks
bacherfl opened this issue Aug 11, 2023 · 12 comments · May be fixed by #3244
Open
2 tasks

Create command for updating auto-generated docs and helm resources for CRD structs #1879

bacherfl opened this issue Aug 11, 2023 · 12 comments · May be fixed by #3244
Assignees
Labels

Comments

@bacherfl
Copy link
Member

bacherfl commented Aug 11, 2023

Details

Currently, whenever a change to a CRD struct in lifecycle-operator/apis or metrics-operator/api is done (e.g. when the name of a field is changed), there is a number of steps to be performed manually to properly adapt that change.

  1. Run make generate in the operator directory to update the zz_autogenerated.deepcopy.go files
  2. Run make manifests to update the CRD manifests in the operator's config directory
  3. Copy the generated manifest for the CRD to helm/chart/templates/ ⚠️ editing needed in the common labels import (see https://github.com/keptn/lifecycle-toolkit/blob/main/helm/chart/templates/analysis-crd.yaml#L7 and https://github.com/keptn/lifecycle-toolkit/blob/main/helm/chart/templates/analysis-crd.yaml#L12)
  4. Update the auto-generated CRD docs by running ./.github/scripts/generate-crd-docs/generate-crd-docs.sh

This process should be made easier by adding a new target in the Makefile that takes care of these steps

DoD

  • Document in our docs the make command to run
  • The command shall be called make resources
@bacherfl bacherfl added status: ready-for-refinement Issue is relevant for the next backlog refinment chore Maintenance labels Aug 11, 2023
@thisthat thisthat removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Aug 16, 2023
@YashPimple
Copy link
Member

Hey @bacherfl would like to work on this issue

@YashPimple
Copy link
Member

Heyy @mowies I had an doubt in the above issue if we see third point in the above issue description copy the generated manifest for the CRD to helm/chart/templates/ so for the generated CRD need to store them in helm/chart/templates/ However it appears that the directory is not present in our current keptn repository so at which other place we can store the generate CRD or should we store them in chart/templates would like to get your views on it ?

@mowies
Copy link
Member

mowies commented Oct 9, 2023

That folder got updated in a recent PR!
Please use chart/templates instead :)

@mowies
Copy link
Member

mowies commented Nov 15, 2023

@YashPimple any updates? :)

@mowies mowies added the good first issue Good for newcomers label Dec 4, 2023
@ShivangShandilya
Copy link
Contributor

I was checking out the Project Roadmap and saw this issue in the backlog, @YashPimple are you working on this issue? If not then I would like to take a look at it.

@mowies
Copy link
Member

mowies commented Jan 15, 2024

@ShivangShandilya I think you're good to take over

@odubajDT
Copy link
Contributor

Hi @ShivangShandilya are you actively working on this issue? Should I assign it to you? Thank you!

@prakrit55
Copy link
Member

prakrit55 commented Jan 23, 2024

@odubajDT, if he is already occupied, I wd like to complete it

@ShivangShandilya
Copy link
Contributor

@prakrit55 you can go ahead with it 👍

@prakrit55
Copy link
Member

Hey @mowies can we pull a script file in each sub directories to copy the crds to the helm templates and also replace the annotations there. The purpose behind it is, the files are differently named in config/crd and helm/templates and configuring it in the makefile wd be wholely messy.

The idea is truely great, to make this thing automated. If you find any other way pls share.

@mowies
Copy link
Member

mowies commented Jan 25, 2024

I guess a script would be fine, but I think you could also just have one script to handle this in the .github/scripts folder for example

Copy link
Contributor

This issue will be unassigned in 1 week if no further activity is seen.
If you are active please provide an update on the status of the issue and if you would like to continue
working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment