📖 Update ClusterExtensionRevision API docs #2350

perdasilva · 2025-11-19T10:25:43Z

Description

Update the ClusterExtensionRevision API docstrings to provide more thorough API documentation for the user.

Note: changes were generated using AI tools and manually updated

Reviewer Checklist

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

netlify · 2025-11-19T10:25:49Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`0dd38aa`
🔍 Latest deploy log	https://app.netlify.com/projects/olmv1/deploys/69287328f7a99e000742f73d
😎 Deploy Preview	https://deploy-preview-2350--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

camilamacedo86

/lgtm

camilamacedo86

Much better 🎉

camilamacedo86 · 2025-11-19T10:32:48Z

Hi @perdasilva

Can we fix the emoj for 📖 ( docs )?

Copilot

Pull Request Overview

This pull request updates the ClusterExtensionRevision API documentation to provide more comprehensive and detailed descriptions for developers and users.

Enhanced top-level API documentation explaining the purpose and lifecycle of ClusterExtensionRevisions
Improved field documentation with detailed explanations of behavior for spec and status fields
Expanded condition documentation explaining all possible condition types, reasons, and their meanings

Reviewed Changes

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

File	Description
api/v1/clusterextensionrevision_types.go	Updated Go API type definitions with comprehensive docstrings for ClusterExtensionRevision types, fields, and constants
manifests/experimental.yaml	Generated CRD manifest with updated OpenAPI schema descriptions matching the Go API documentation
manifests/experimental-e2e.yaml	Generated E2E CRD manifest with updated OpenAPI schema descriptions matching the Go API documentation
helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensionrevisions.yaml	Helm chart CRD with updated OpenAPI schema descriptions matching the Go API documentation

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

api/v1/clusterextensionrevision_types.go

manifests/experimental.yaml

manifests/experimental-e2e.yaml

...operator-controller/crd/experimental/olm.operatorframework.io_clusterextensionrevisions.yaml

api/v1/clusterextensionrevision_types.go

camilamacedo86 · 2025-11-19T10:37:04Z

@perdasilva I think it is also valid to address the Copilot reviews. WDYT?

codecov · 2025-11-19T10:39:49Z

Codecov Report

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2350      +/-   ##
==========================================
- Coverage   74.45%   74.36%   -0.09%     
==========================================
  Files          93       93              
  Lines        7300     7300              
==========================================
- Hits         5435     5429       -6     
- Misses       1433     1436       +3     
- Partials      432      435       +3

Flag	Coverage Δ
e2e	`44.47% <ø> (-0.05%)`	⬇️
experimental-e2e	`48.69% <ø> (-0.05%)`	⬇️
unit	`58.47% <ø> (ø)`

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.

perdasilva · 2025-11-19T11:28:09Z

@perdasilva I think it is also valid to address the Copilot reviews. WDYT?

Done =D

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 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.

api/v1/clusterextensionrevision_types.go

rashmigottipati

/lgtm

tmshort · 2025-11-19T14:16:55Z

/hold
@perdasilva: To allow other people to give it a look while I throw on an approval. Please remove when you think we've had enough eyes on it.

perdasilva · 2025-11-19T15:02:16Z

/hold @perdasilva: To allow other people to give it a look while I throw on an approval. Please remove when you think we've had enough eyes on it.

good thinking! thank you!!

michaelryanpeter

So I've looked it over, and I think it is pretty good overall, but I find the way that the LLM described the fields to be really confusing. For example, "phases is an optional, immutable list of phases..." or "objects is...". I think that something like "the phases property/field specifies an optional, immutaable list of phases. A phase is a ..." would be easier to grok. But I don't think this is a blocker and I know time is tight. Since it is tech preview, we can update these comments right?

...operator-controller/crd/experimental/olm.operatorframework.io_clusterextensionrevisions.yaml

perdasilva · 2025-11-24T09:09:49Z

/unhold

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

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

api/v1/clusterextensionrevision_types.go

pedjak · 2025-11-27T09:38:39Z

api/v1/clusterextensionrevision_types.go

+// A ClusterExtensionRevision represents a specific immutable snapshot of the objects
+// to be installed for a ClusterExtension. Each revision is rolled out in phases,
+// with objects organized by their Group-Kind into well-known phases such as namespaces,
+// rbac, crds, and deploy.


This doc refers ClusterExtensionRevision, thus it should be placed on type ClusterExtensionRevision struct

api/v1/clusterextensionrevision_types.go

pedjak · 2025-11-27T10:10:28Z

api/v1/clusterextensionrevision_types.go

+//
+// The revision rollout uses a phased approach where objects apply in a defined order based
+// on type (for example: namespaces, then RBAC, then CRDs, then deployments). All objects
+// in a phase apply simultaneously and must pass readiness probes before rollout continues


see earlier comments on "simultaneously"

I'm having trouble finding the early comment. But, I've gone ahead and removed this for now as it speaks to implementation. Having said that, I think we're still a bit fuzzy on how we want to present this API to the user and how much that phased approach with progression checks are implementation detail vs a first class mental model that the user should have in their heads.

api/v1/clusterextensionrevision_types.go

Copilot

Pull request overview

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

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

api/v1/clusterextensionrevision_types.go

...operator-controller/crd/experimental/olm.operatorframework.io_clusterextensionrevisions.yaml

manifests/experimental.yaml

manifests/experimental-e2e.yaml

api/v1/clusterextensionrevision_types.go

rashmigottipati

/approve

Signed-off-by: Per Goncalves da Silva <[email protected]>

pedjak

/lgtm nice work!

openshift-ci · 2025-11-27T17:17:49Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~api/OWNERS~~ [tmshort]
~~helm/OWNERS~~ [camilamacedo86,tmshort]
~~manifests/OWNERS~~ [camilamacedo86,tmshort]

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

Copilot AI review requested due to automatic review settings November 19, 2025 10:25

perdasilva requested a review from a team as a code owner November 19, 2025 10:25

openshift-ci bot requested review from joelanford and rashmigottipati November 19, 2025 10:25

Copilot started reviewing on behalf of perdasilva November 19, 2025 10:26 View session

Copilot finished reviewing on behalf of perdasilva November 19, 2025 10:29

camilamacedo86 approved these changes Nov 19, 2025

View reviewed changes

openshift-ci bot assigned camilamacedo86 Nov 19, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 19, 2025

camilamacedo86 reviewed Nov 19, 2025

View reviewed changes

perdasilva changed the title ~~🌱 Update ClusterExtensionRevision API docs~~ 📖 : Update ClusterExtensionRevision API docs Nov 19, 2025

perdasilva changed the title ~~📖 : Update ClusterExtensionRevision API docs~~ 📖 Update ClusterExtensionRevision API docs Nov 19, 2025

Copilot AI reviewed Nov 19, 2025

View reviewed changes

perdasilva force-pushed the cer-docs branch from f8585ea to 6d18fdd Compare November 19, 2025 11:15

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 19, 2025

camilamacedo86 requested a review from Copilot November 19, 2025 12:25

Copilot started reviewing on behalf of camilamacedo86 November 19, 2025 12:25 View session

Copilot finished reviewing on behalf of camilamacedo86 November 19, 2025 12:26

Copilot AI reviewed Nov 19, 2025

View reviewed changes

rashmigottipati reviewed Nov 19, 2025

View reviewed changes

api/v1/clusterextensionrevision_types.go Outdated Show resolved Hide resolved

rashmigottipati approved these changes Nov 19, 2025

View reviewed changes

openshift-ci bot assigned rashmigottipati Nov 19, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 19, 2025

openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 19, 2025

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 19, 2025

michaelryanpeter reviewed Nov 19, 2025

View reviewed changes

...operator-controller/crd/experimental/olm.operatorframework.io_clusterextensionrevisions.yaml Outdated Show resolved Hide resolved

perdasilva force-pushed the cer-docs branch from 6d18fdd to a10c906 Compare November 24, 2025 08:02

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 24, 2025

openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 24, 2025

Copilot AI review requested due to automatic review settings November 26, 2025 15:31

perdasilva force-pushed the cer-docs branch from a10c906 to 2c714ef Compare November 26, 2025 15:31

Copilot started reviewing on behalf of perdasilva November 26, 2025 15:32 View session

Copilot finished reviewing on behalf of perdasilva November 26, 2025 15:34

Copilot AI reviewed Nov 26, 2025

View reviewed changes

api/v1/clusterextensionrevision_types.go Outdated Show resolved Hide resolved

perdasilva force-pushed the cer-docs branch from 2c714ef to 2fa7c55 Compare November 27, 2025 09:10

pedjak reviewed Nov 27, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings November 27, 2025 12:54

perdasilva force-pushed the cer-docs branch from 2fa7c55 to 10c57dd Compare November 27, 2025 12:54

Copilot started reviewing on behalf of perdasilva November 27, 2025 12:55 View session

Copilot finished reviewing on behalf of perdasilva November 27, 2025 12:56

Copilot AI reviewed Nov 27, 2025

View reviewed changes

pedjak reviewed Nov 27, 2025

View reviewed changes

api/v1/clusterextensionrevision_types.go Show resolved Hide resolved

rashmigottipati approved these changes Nov 27, 2025

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 27, 2025

Update ClusterExtensionRevision API docs

0dd38aa

Signed-off-by: Per Goncalves da Silva <[email protected]>

perdasilva force-pushed the cer-docs branch from 10c57dd to 0dd38aa Compare November 27, 2025 15:49

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 27, 2025

pedjak approved these changes Nov 27, 2025

View reviewed changes

openshift-ci bot assigned pedjak Nov 27, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 27, 2025

openshift-merge-bot bot merged commit 4355cde into operator-framework:main Nov 27, 2025
27 checks passed

📖 Update ClusterExtensionRevision API docs #2350

📖 Update ClusterExtensionRevision API docs #2350

Uh oh!

Conversation

perdasilva commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Reviewer Checklist

Uh oh!

netlify bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

camilamacedo86 left a comment

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 left a comment

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

camilamacedo86 commented Nov 19, 2025

Uh oh!

codecov bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

perdasilva commented Nov 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

rashmigottipati left a comment

Choose a reason for hiding this comment

Uh oh!

tmshort commented Nov 19, 2025

Uh oh!

perdasilva commented Nov 19, 2025

Uh oh!

michaelryanpeter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

perdasilva commented Nov 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

pedjak Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pedjak Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

perdasilva Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

perdasilva commented Nov 19, 2025 •

edited

Loading

netlify bot commented Nov 19, 2025 •

edited

Loading

camilamacedo86 commented Nov 19, 2025 •

edited

Loading

codecov bot commented Nov 19, 2025 •

edited

Loading