Skip to content

🌱 Update inline config docs and annotations - #2366

Merged
openshift-merge-bot[bot] merged 1 commit into
operator-framework:mainfrom
perdasilva:sons-updates
Dec 5, 2025
Merged

🌱 Update inline config docs and annotations#2366
openshift-merge-bot[bot] merged 1 commit into
operator-framework:mainfrom
perdasilva:sons-updates

Conversation

@perdasilva

@perdasilvaperdasilva commented Nov 28, 2025

Copy link
Copy Markdown
Contributor

Description

Addresses enhancement PR reviewer comments by:

  • Updates inline configuration documentation
  • Adds missing // +unionMember annotation to Inline
  • Adds // +kubebuilder:validation:MinProperties=1 validation to Inline to ensure empty configurations {} cannot be specified
  • Adds additional admission unit test inc. to test the added validation annotation

Reviewer Checklist

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

CopilotAI review requested due to automatic review settings November 28, 2025 15:23
@perdasilva
perdasilva requested a review from a team as a code ownerNovember 28, 2025 15:23
@netlify

netlifyBot commented Nov 28, 2025

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commit6b65cca
🔍 Latest deploy loghttps://app.netlify.com/projects/olmv1/deploys/692ef2b84e13370008e88851
😎 Deploy Previewhttps://deploy-preview-2366--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 project configuration.

@perdasilvaperdasilva changed the title Update inline config docs and annotations🌱 Update inline config docs and annotationsNov 28, 2025

CopilotAI 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.

Pull request overview

This PR improves the inline configuration documentation and adds the +unionMember annotation to the ClusterExtensionConfig.Inline field as suggested by an API review. The changes make the documentation clearer, fix a grammatical error in the original text, and ensure proper union type annotation for the Kubernetes API.

Key Changes:

  • Rewrote inline configuration documentation for better clarity and grammar
  • Added // +unionMember annotation to the Inline field in ClusterExtensionConfig
  • Updated all generated CRD manifests and API documentation to reflect the source changes

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
FileDescription
api/v1/clusterextension_types.goUpdated inline configuration documentation comments and added +unionMember annotation
manifests/experimental.yamlGenerated CRD manifest updated with new documentation text
manifests/experimental-e2e.yamlGenerated E2E CRD manifest updated with new documentation text
helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yamlHelm CRD manifest updated with new documentation text
docs/api-reference/olmv1-api-reference.mdAPI reference documentation updated to match source code comments

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov

codecovBot commented Dec 1, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.51%. Comparing base (34394ce) to head (6b65cca).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #2366 +/- ##
==========================================
+ Coverage 70.61% 74.51% +3.90% 
==========================================
Files 93 93 Lines 7333 7333 ==========================================
+ Hits 5178 5464 +286 + Misses 1720 1435 -285 + Partials 435 434 -1 
FlagCoverage Δ
e2e44.47% <ø> (-0.07%)⬇️
experimental-e2e48.78% <ø> (+34.83%)⬆️
unit58.61% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tmshort

Copy link
Copy Markdown
Contributor

/approve

@openshift-ciopenshift-ciBot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 1, 2025
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

CopilotAI 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.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadapi/v1/clusterextension_types.go

@pedjakpedjak 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

@openshift-ciopenshift-ciBot added the lgtm Indicates that a PR is ready to be merged. label Dec 5, 2025
@openshift-ci

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pedjak, tmshort

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot
openshift-merge-botBot merged commit d26dbc5 into operator-framework:mainDec 5, 2025
47 of 49 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.lgtmIndicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@perdasilva@tmshort@pedjak