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: fix auto-generated API docs having wrong metadata info #2927

Merged
merged 7 commits into from
Feb 1, 2024

Conversation

RealAnna
Copy link
Contributor

@RealAnna RealAnna commented Jan 31, 2024

context spec metadata in crd ref now has the correct reference info, metadata for k8s now links to https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects

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 requested review from a team as code owners January 31, 2024 15:21
@github-actions github-actions bot added documentation Improvements or additions to documentation ops labels Jan 31, 2024
Signed-off-by: RealAnna <anna.reale@dynatrace.com>
Signed-off-by: RealAnna <anna.reale@dynatrace.com>
Copy link

codecov bot commented Jan 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c7ee4fb) 85.87% compared to head (075a409) 85.88%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2927   +/-   ##
=======================================
  Coverage   85.87%   85.88%           
=======================================
  Files         161      161           
  Lines       10252    10252           
=======================================
+ Hits         8804     8805    +1     
  Misses       1166     1166           
+ Partials      282      281    -1     

see 3 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 67.42% <ø> (ø)
component-tests 56.49% <ø> (+0.06%) ⬆️
lifecycle-operator 84.88% <ø> (ø)
metrics-operator 87.63% <ø> (ø)
scheduler 36.53% <ø> (ø)

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

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.

the fix works 🙌🏼
but the sentence is not really a sentence 🤔

Refer to Kubernetes API documentation for fields of metadata.

@RealAnna
Copy link
Contributor Author

that was the original sentence XD I will
come up with a better one

Signed-off-by: RealAnna <anna.reale@dynatrace.com>
thisthat
thisthat previously approved these changes Jan 31, 2024
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.

:shipit:

@mowies mowies changed the title chore: fix crd gen wrong metadata info chore: fix auto-generated API docs having wrong metadata info Jan 31, 2024
mowies
mowies previously approved these changes Jan 31, 2024
Signed-off-by: RealAnna <anna.reale@dynatrace.com>
@RealAnna RealAnna dismissed stale reviews from mowies and thisthat via 075a409 February 1, 2024 06:44
Copy link

sonarcloud bot commented Feb 1, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@RealAnna RealAnna merged commit a28d037 into main Feb 1, 2024
34 checks passed
@RealAnna RealAnna deleted the fix/crd-gen branch February 1, 2024 07:27
bacherfl pushed a commit to bacherfl/lifecycle-controller that referenced this pull request Feb 5, 2024
…2927)

Signed-off-by: RealAnna <anna.reale@dynatrace.com>
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
…2927)

Signed-off-by: RealAnna <anna.reale@dynatrace.com>
Signed-off-by: vickysomtee <vickysomtee@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 ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants