Skip to content

📖 Update GoDoc comments for the ClusterExtension API #1158

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

Merged
merged 5 commits into from
Aug 22, 2024

Conversation

everettraven
Copy link
Contributor

Description

Updates the GoDoc comments in the ClusterExtension API to be more user readable, user the JSON field name in references, and ensures all optional fields are marked with the //+optional comment tag

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@everettraven everettraven requested a review from a team as a code owner August 21, 2024 14:03
Copy link

netlify bot commented Aug 21, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 076fbad
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/66c64a8fabd58600082c7722
😎 Deploy Preview https://deploy-preview-1158--olmv1.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.

Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.45%. Comparing base (6008832) to head (076fbad).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1158   +/-   ##
=======================================
  Coverage   75.45%   75.45%           
=======================================
  Files          35       35           
  Lines        1919     1919           
=======================================
  Hits         1448     1448           
  Misses        329      329           
  Partials      142      142           
Flag Coverage Δ
e2e 58.20% <ø> (ø)
unit 50.85% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@everettraven
Copy link
Contributor Author

There are a couple PRs that are in the merge queue that will require a rebase for these changes. Adding a hold for now

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 21, 2024
Signed-off-by: everettraven <[email protected]>
Signed-off-by: everettraven <[email protected]>
Signed-off-by: everettraven <[email protected]>
@everettraven
Copy link
Contributor Author

Rebased on latest merged API changes. unholding

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 21, 2024
@everettraven everettraven enabled auto-merge August 21, 2024 20:43
Copy link
Contributor

@tmshort tmshort left a comment

Choose a reason for hiding this comment

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

/lgtm

@everettraven everettraven added this pull request to the merge queue Aug 22, 2024
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 22, 2024
Copy link
Member

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

/lgtm

Merged via the queue into operator-framework:main with commit 21670ae Aug 22, 2024
17 of 18 checks passed
@skattoju skattoju mentioned this pull request Sep 25, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
3 participants