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

chore: add status field docs to all CRDs #1807

Merged
merged 12 commits into from
Aug 2, 2023
Merged

Conversation

RealAnna
Copy link
Contributor

@RealAnna RealAnna commented Jul 31, 2023

this pr adds status information to all CRDs where KLT sets the field.

@RealAnna RealAnna requested review from a team as code owners July 31, 2023 11:18
@github-actions github-actions bot added documentation Improvements or additions to documentation ops labels Jul 31, 2023
@netlify
Copy link

netlify bot commented Jul 31, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 984801a
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/64ca452bbc158800088edf77
😎 Deploy Preview https://deploy-preview-1807--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Jul 31, 2023

Codecov Report

Merging #1807 (7c00c4e) into main (ee2abea) will decrease coverage by 1.96%.
The diff coverage is n/a.

❗ Current head 7c00c4e differs from pull request most recent head 984801a. Consider uploading reports for the commit 984801a to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1807      +/-   ##
==========================================
- Coverage   63.57%   61.61%   -1.96%     
==========================================
  Files         143      118      -25     
  Lines       10937     9713    -1224     
==========================================
- Hits         6953     5985     -968     
+ Misses       3722     3512     -210     
+ Partials      262      216      -46     
Files Changed Coverage Δ
operator/apis/lifecycle/v1alpha1/common/common.go 100.00% <ø> (ø)
...ecycle/v1alpha1/keptnevaluationdefinition_types.go 100.00% <ø> (ø)
...ifecycle/v1alpha1/keptnevaluationprovider_types.go 100.00% <ø> (ø)
...r/apis/lifecycle/v1alpha1/zz_generated.deepcopy.go 0.00% <ø> (ø)
operator/apis/lifecycle/v1alpha2/common/common.go 100.00% <ø> (ø)
...ecycle/v1alpha2/keptnevaluationdefinition_types.go 100.00% <ø> (ø)
...ifecycle/v1alpha2/keptnevaluationprovider_types.go 100.00% <ø> (ø)
...r/apis/lifecycle/v1alpha2/zz_generated.deepcopy.go 0.00% <ø> (ø)
operator/apis/lifecycle/v1alpha3/common/common.go 100.00% <ø> (ø)
...ifecycle/v1alpha3/keptnappcreationrequest_types.go 80.00% <ø> (ø)
... and 3 more

... and 25 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 68.55% <ø> (ø)
lifecycle-operator 84.91% <ø> (ø)
metrics-operator ?
scheduler 32.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@mowies mowies changed the title chore: regenerate crd docs chore: add status field docs to all CRDs Jul 31, 2023
StackScribe
StackScribe previously approved these changes Jul 31, 2023
Copy link
Contributor

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

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

Thanks, Anna!

mowies
mowies previously approved these changes Jul 31, 2023
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

LGTM but please test if installation of the CRDs still works with helm

@RealAnna RealAnna marked this pull request as draft July 31, 2023 15:52
@RealAnna
Copy link
Contributor Author

LGTM but please test if installation of the CRDs still works with helm

I am testing this, it seems like the crds are not updated by helm upgrade :(

@RealAnna RealAnna dismissed stale reviews from mowies and StackScribe via ed03513 August 1, 2023 08:02
@RealAnna RealAnna marked this pull request as ready for review August 1, 2023 09:24
@RealAnna RealAnna force-pushed the chore/add_status_to_crd_docs branch from d82281f to 7d89716 Compare August 1, 2023 12:20
@odubajDT
Copy link
Contributor

odubajDT commented Aug 2, 2023

Looks good :) but we can have an EmptyStatus also in KeptnAppCreationRequest, can you adapt it there as well ? :)

odubajDT
odubajDT previously approved these changes Aug 2, 2023
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: realanna <anna.reale@dynatrace.com>
@RealAnna RealAnna force-pushed the chore/add_status_to_crd_docs branch 2 times, most recently from 76f8062 to 47b3d9a Compare August 2, 2023 11:52
Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: persist-credentials: false

Signed-off-by: realanna <anna.reale@dynatrace.com>

test

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: review

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: review

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: review

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: review

Signed-off-by: realanna <anna.reale@dynatrace.com>

Update .github/scripts/generate-crd-docs/crd-docs-generator-config.yaml

Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: RealAnna <89971034+RealAnna@users.noreply.github.com>

fix crd docs generation by introducing dummy change

Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>

fix: regenerate manifests

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: regenerate manifests

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: regenerate manifests

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: regenerate manifests

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: add custom empty status

Signed-off-by: realanna <anna.reale@dynatrace.com>

fix: add custom empty status

Signed-off-by: realanna <anna.reale@dynatrace.com>
@RealAnna RealAnna force-pushed the chore/add_status_to_crd_docs branch from 7c00c4e to 446ff36 Compare August 2, 2023 11:57
Signed-off-by: realanna <anna.reale@dynatrace.com>
@sonarcloud
Copy link

sonarcloud bot commented Aug 2, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Member

@bacherfl bacherfl left a comment

Choose a reason for hiding this comment

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

lgtm

@RealAnna RealAnna merged commit 650ecba into main Aug 2, 2023
32 of 33 checks passed
@RealAnna RealAnna deleted the chore/add_status_to_crd_docs branch August 2, 2023 12:01
prakrit55 pushed a commit to prakrit55/lifecycle-toolkit that referenced this pull request Aug 3, 2023
Signed-off-by: realanna <anna.reale@dynatrace.com>
Signed-off-by: Griffin <prakritimandal611@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation metrics-operator ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants