Skip to content

Conversation

@perdasilva
Copy link
Contributor

Description

Makes a small update to the .spec.config docs to direct users to OLM documentation for more information on configuring bundles.

Reviewer Checklist

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

Copilot AI review requested due to automatic review settings December 12, 2025 09:34
@perdasilva perdasilva requested a review from a team as a code owner December 12, 2025 09:34
@netlify
Copy link

netlify bot commented Dec 12, 2025

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 5a2a49e
🔍 Latest deploy log https://app.netlify.com/projects/olmv1/deploys/693be76333b09f000841632d
😎 Deploy Preview https://deploy-preview-2383--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.

Copy link

Copilot AI left a comment

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 updates the API documentation for the .spec.config field in the ClusterExtension API to provide clearer guidance on bundle configuration and direct users to the OLM documentation.

Key Changes:

  • Updates the behavior description when a bundle doesn't provide a configuration schema from "manifests will be derived on a best-effort basis" to "the bundle is deemed to not be configurable"
  • Redirects users from bundle-specific end-user documentation to the OLM documentation for configuration guidance

Reviewed changes

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

File Description
api/v1/clusterextension_types.go Updates the Go API documentation for the Config field to clarify behavior and documentation reference
helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml Updates the CRD manifest documentation to match the Go API changes
manifests/experimental.yaml Updates the experimental manifest documentation to match the Go API changes
manifests/experimental-e2e.yaml Updates the E2E experimental manifest documentation to match the Go API changes

The documentation updates are consistent across all files and improve clarity for users by providing a more accurate description of the behavior and directing them to centralized OLM documentation rather than bundle-specific documentation. No issues were identified in this PR.


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

@codecov
Copy link

codecov bot commented Dec 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.10%. Comparing base (d66afb6) to head (5a2a49e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2383      +/-   ##
==========================================
+ Coverage   73.05%   73.10%   +0.05%     
==========================================
  Files         100      100              
  Lines        7641     7641              
==========================================
+ Hits         5582     5586       +4     
+ Misses       1623     1621       -2     
+ Partials      436      434       -2     
Flag Coverage Δ
e2e 44.73% <ø> (ø)
experimental-e2e 41.68% <ø> (-7.69%) ⬇️
unit 57.11% <ø> (ø)

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.

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
Copy link
Contributor

@pedjak pedjak left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 12, 2025
@openshift-ci
Copy link

openshift-ci bot commented Dec 12, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pedjak

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-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 12, 2025
@openshift-merge-bot openshift-merge-bot bot merged commit 39718ba into operator-framework:main Dec 12, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants