Skip to content

📖 Update GoDoc comments for the ClusterExtension API - #1158

Merged
everettraven merged 5 commits into
operator-framework:mainfrom
everettraven:v1-api-comments
Aug 22, 2024
Merged

📖 Update GoDoc comments for the ClusterExtension API#1158
everettraven merged 5 commits into
operator-framework:mainfrom
everettraven:v1-api-comments

Conversation

@everettraven

Copy link
Copy Markdown
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 ownerAugust 21, 2024 14:03
@netlify

netlifyBot commented Aug 21, 2024

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commit076fbad
🔍 Latest deploy loghttps://app.netlify.com/sites/olmv1/deploys/66c64a8fabd58600082c7722
😎 Deploy Previewhttps://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.

@codecov

codecovBot commented Aug 21, 2024

Copy link
Copy Markdown

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 
FlagCoverage Δ
e2e58.20% <ø> (ø)
unit50.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
Copy Markdown
ContributorAuthor

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-ciopenshift-ciBot 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 <everettraven@gmail.com>
Signed-off-by: everettraven <everettraven@gmail.com>
Signed-off-by: everettraven <everettraven@gmail.com>
Signed-off-by: everettraven <everettraven@gmail.com>
Signed-off-by: everettraven <everettraven@gmail.com>
@everettraven

Copy link
Copy Markdown
ContributorAuthor

Rebased on latest merged API changes. unholding

/hold cancel

@openshift-ciopenshift-ciBot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 21, 2024

@tmshorttmshort left a comment

Copy link
Copy Markdown
Contributor

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-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Aug 22, 2024

@rashmigottipatirashmigottipati left a comment

Copy link
Copy Markdown
Member

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 21670aeAug 22, 2024
@skattojuskattoju mentioned this pull request Sep 25, 2024
4 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtmIndicates that a PR is ready to be merged.

Projects

None yet

3 participants

@everettraven@rashmigottipati@tmshort