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

docs: added comments to document the meaning of CRD properties #1360

Merged
merged 15 commits into from
May 9, 2023
Merged

docs: added comments to document the meaning of CRD properties #1360

merged 15 commits into from
May 9, 2023

Conversation

bacherfl
Copy link
Member

@bacherfl bacherfl commented May 3, 2023

No description provided.

@bacherfl
added comments to describe KeptnApp properties
9494183 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
added comments to describe KeptnAppVersion and KeptnAppCreationReques…
5244c9c 
…t properties

Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@netlify
Copy link

netlify bot commented May 3, 2023 •
edited
Loading

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit d569e95
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6454d4a0ac5d7800081cabbf
😎 Deploy Preview https://deploy-preview-1360--keptn-lifecycle-toolkit.netlify.app/docs/crd-ref/lifecycle/v1alpha3
📱 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 settings.

@codecov
Copy link

codecov bot commented May 3, 2023 •
edited
Loading

Codecov Report

Merging #1360 (d569e95) into main (dadd70b) will increase coverage by 0.20%.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1360      +/-   ##
==========================================
+ Coverage   61.57%   61.77%   +0.20%     
==========================================
  Files         143      143              
  Lines       10697    10719      +22     
==========================================
+ Hits         6587     6622      +35     
+ Misses       3849     3836      -13     
  Partials      261      261
Impacted Files Coverage Δ
operator/apis/lifecycle/v1alpha3/keptnapp_types.go 93.33% <ø> (ø)
...ifecycle/v1alpha3/keptnappcreationrequest_types.go 80.00% <ø> (ø)
...r/apis/lifecycle/v1alpha3/keptnappversion_types.go 97.64% <ø> (ø)
...r/apis/lifecycle/v1alpha3/keptnevaluation_types.go 97.29% <ø> (ø)
...ecycle/v1alpha3/keptnevaluationdefinition_types.go 100.00% <ø> (ø)
...perator/apis/lifecycle/v1alpha3/keptntask_types.go 97.59% <ø> (ø)
...is/lifecycle/v1alpha3/keptntaskdefinition_types.go 100.00% <ø> (ø)
...tor/apis/lifecycle/v1alpha3/keptnworkload_types.go 93.93% <ø> (ø)
.../lifecycle/v1alpha3/keptnworkloadinstance_types.go 95.41% <ø> (ø)

... and 5 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 68.55% <ø> (ø)
component-tests 60.17% <ø> (+0.94%) ⬆️
lifecycle-operator 82.50% <ø> (+0.02%) ⬆️
metrics-operator 77.90% <ø> (ø)
scheduler 21.75% <ø> (ø)

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

@bacherfl
Merge branch 'main' into docs/crd-docs
2e50640
@bacherfl
added documentation for KeptnEvaluation CRD
42931a8 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
added documentation for KeptnEvaluationDefinition and KeptnTask CRDs
16a183d 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
added documentation for remaining lifecycle CRDs
2715a3d 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
Merge branch 'main' into docs/crd-docs
7630aa2
@bacherfl
executed make manifests
3b0e600 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
Merge remote-tracking branch 'origin/docs/crd-docs' into docs/crd-docs
7afec41
@bacherfl bacherfl marked this pull request as ready for review May 4, 2023 13:36
@bacherfl bacherfl requested a review from a team as a code owner May 4, 2023 13:36
bacherfl and others added 2 commits May 5, 2023 07:48
@bacherfl @thisthat
added missing dot
bca849e 
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
generate crd docs
fece8f9 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl bacherfl requested a review from a team as a code owner May 5, 2023 05:52
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 5, 2023
@bacherfl
added dots to all comments
a1e61b3 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
odubajDT
odubajDT previously approved these changes May 5, 2023
View reviewed changes
@bacherfl
pr review
667dcf6 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
RealAnna
RealAnna previously approved these changes May 5, 2023
View reviewed changes
thisthat
thisthat reviewed May 5, 2023
View reviewed changes
operator/apis/lifecycle/v1alpha3/keptnapp_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnappversion_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnappversion_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnevaluation_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnevaluationdefinition_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go Outdated Show resolved Hide resolved
operator/apis/lifecycle/v1alpha3/keptnworkloadinstance_types.go Outdated Show resolved Hide resolved
@bacherfl @thisthat
Apply suggestions from code review
ae40e7c 
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@bacherfl
regenerate manifests and docs
d569e95 
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
@sonarcloud
Copy link

sonarcloud bot commented May 5, 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
1.3% 1.3% Duplication

thisthat
thisthat approved these changes May 5, 2023
View reviewed changes
Copy link
Member

@thisthat thisthat left a comment

Choose a reason for hiding this comment

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

Thanks @bacherfl 🙌

@bacherfl bacherfl merged commit a8bc440 into keptn:main May 9, 2023
@keptn-bot keptn-bot mentioned this pull request May 9, 2023
Merged
@keptn-bot keptn-bot mentioned this pull request Jun 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@odubajDT odubajDT odubajDT approved these changes

@thisthat thisthat thisthat approved these changes

@RealAnna RealAnna RealAnna left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bacherfl @thisthat @RealAnna @odubajDT