OCPBUGS-79068: Fix HelmChartRepository YAML format#1129
OCPBUGS-79068: Fix HelmChartRepository YAML format#1129jhadvig wants to merge 1 commit intoopenshift:mainfrom
Conversation
openshift-ci-robot
added
jira/severity-moderate
|
@jhadvig: This pull request references Jira Issue OCPBUGS-79068, which is invalid:
Comment The bug has been updated to refer to the pull request using the external bug tracker. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
approved
|
/jira refresh |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📜 Recent review details🧰 Additional context used🔀 Multi-repo context openshift/consoleFindings (repository: openshift/console) [::openshift/console::]
Notes:
Tag: WalkthroughUpdated a YAML ConsoleQuickStart resource's description field from folded scalar to literal block scalar formatting, including re-indentation of embedded HelmChartRepository manifest code blocks and surrounding whitespace adjustments while preserving manifest content values. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
openshift-ci-robot
added
jira/valid-bug
|
@jhadvig: This pull request references Jira Issue OCPBUGS-79068, which is valid. The bug has been moved to the POST state. 3 validation(s) were run on this bug
DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@quickstarts/Untitled`:
- Line 1: The file named "Untitled" in the quickstarts package contains a stray
raw URL and is not a valid quickstart; delete this file or replace its contents
with a proper ConsoleQuickStart YAML (ensure the resource kind is
ConsoleQuickStart and include the required cluster profile annotations and other
required metadata) so it becomes a valid quickstart instead of a plain URL.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: b58b13f1-afa2-4e79-8e08-b72ee1b6458d
📒 Files selected for processing (2)
quickstarts/Untitledquickstarts/manage-helm-repos.yaml
📜 Review details
🧰 Additional context used
📓 Path-based instructions (2)
**
⚙️ CodeRabbit configuration file
-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.
Files:
quickstarts/Untitledquickstarts/manage-helm-repos.yaml
quickstarts/**/*.yaml
⚙️ CodeRabbit configuration file
quickstarts/**/*.yaml: Review quickstart YAML definitions.
Ensure cluster profile annotations are present.
See quickstarts/README.md for guidelines.
Files:
quickstarts/manage-helm-repos.yaml
🔀 Multi-repo context openshift/console
[::openshift/console::] quickstarts/manage-helm-repos.yaml — changed YAML description scalar style (PR under review). (file path from PR context)
Findings (repositories searched: openshift/console)
-
CRD/type definitions (API types used by code)
- vendor/github.com/openshift/api/helm/v1beta1/types_helm_chart_repository.go — HelmChartRepository, HelmChartRepositorySpec, HelmChartRepositoryStatus definitions. [::openshift/console::]
- vendor/github.com/openshift/api/helm/v1beta1/zz_generated.featuregated-crd-manifests.yaml — CRD KindName: HelmChartRepository / ProjectHelmChartRepository. [::openshift/console::]
-
Backend/logic consuming HelmChartRepository
- pkg/helm/chartproxy/* — multiple tests and code reference HelmChartRepository and ProjectHelmChartRepository (proxy_test.go, repos_test.go). These use the CR type and dynamic clients. Changes in example YAML formatting are unlikely to impact code but this is the codepath that reads HelmChartRepository CRs. [::openshift/console::]
-
Documentation referencing HelmChartRepository
- docs/helm/configure-3rdparty-repos-access.md — examples and docs showing HelmChartRepository CR structure and index URL. Update to YAML formatting in quickstarts may need to remain consistent with docs. [::openshift/console::]
-
Frontend consumers (many places in helm-plugin)
- frontend/packages/helm-plugin/*
- models/helm.ts — HelmChartRepositoryModel and ProjectHelmChartRepositoryModel (kind and apiGroup). [::openshift/console::]
- src/providers/helm-detection-provider.ts — fetchK8s called with HelmChartRepositoryModel and ProjectHelmChartRepositoryModel. [::openshift/console::]
- src/components/forms/HelmChartRepository/* — form creation, parsing YAML input (safeLoad), convertToHelmChartRepository utilities; CreateHelmChartRepositoryForm reads YAML and constructs CR objects. These components parse YAML provided by users and will be sensitive to YAML content/indentation. [::openshift/console::]
- src/catalog/providers/useHelmCharts.tsx, various list-page and catalog components — rely on resource fields (spec.url etc.) from HelmChartRepository objects. [::openshift/console::]
- integration-tests and e2e support data include example HelmChartRepository YAML (integration-tests/test-data/red-hat-helm-charts.yaml, features referencing the Azure-Samples index URL). [::openshift/console::]
- frontend/packages/helm-plugin/*
-
Tests and test-data
- pkg/helm/chartproxy/repos_test.go and proxy_test.go — unit tests create fake dynamic clients with HelmChartRepository objects. [::openshift/console::]
- frontend/packages/helm-plugin/integration-tests/test-data/* — sample HelmChartRepository CRs used in tests; features reference the same example index URL as quickstarts. [::openshift/console::]
Short assessment
- The PR edits quickstarts YAML formatting and adds a file with a single URL. There are many consumers of HelmChartRepository CRs across backend (chartproxy), frontend (helm-plugin forms/parsers, models, providers), docs, and tests. The substantive API/field names (apiVersion, kind, metadata, spec.url) are unchanged per PR description; the change is YAML scalar formatting and indentation in a quickstart example.
- Potentially relevant area: frontend CreateHelmChartRepository form/parser uses safeLoad to parse pasted YAML; changing literal vs folded block style could affect how embedded code fences or indentation are interpreted in the quickstart sample if users copy/paste into the form. Tests and integration test data also include YAML examples that should remain consistent with expected parsing. Backend dynamic clients/tests use object structures, not raw YAML strings, so they are unaffected.
If you want, I can:
- Open and show the exact contents of quickstarts/manage-helm-repos.yaml and quickstarts/Untitled to confirm the exact formatting change and the URL added. (I attempted to print them earlier but relied on repo listing; I can print file contents on request.)
🔇 Additional comments (1)
quickstarts/manage-helm-repos.yaml (1)
33-57: Good fix: literal block preserves the YAML example formatting correctly.This change improves copy/paste reliability of the embedded CR example and keeps the task instructions readable.
quickstarts/Untitled
Outdated
| @@ -0,0 +1 @@ | |||
| https://raw.githubusercontent.com/Azure-Samples/helm-charts/master/docs No newline at end of file | |||
There was a problem hiding this comment.
Remove this stray non-quickstart file from quickstarts/.
This file is just a raw URL and is not a valid quickstart definition. It should be deleted (or replaced with a proper ConsoleQuickStart YAML if that was the intent).
Suggested change
-https://raw.githubusercontent.com/Azure-Samples/helm-charts/master/docsAs per coding guidelines, "Quick starts must be placed under quickstarts/ in this repo" and quick start YAML should include required cluster profile annotations.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@quickstarts/Untitled` at line 1, The file named "Untitled" in the quickstarts
package contains a stray raw URL and is not a valid quickstart; delete this file
or replace its contents with a proper ConsoleQuickStart YAML (ensure the
resource kind is ConsoleQuickStart and include the required cluster profile
annotations and other required metadata) so it becomes a valid quickstart
instead of a plain URL.
|
@jhadvig: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
quickstarts/Untitled
Outdated
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jhadvig, TheRealJon The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@jhadvig: This pull request references Jira Issue OCPBUGS-79068, which is valid. 3 validation(s) were run on this bug
DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
/woof |
DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
3 participants
@assign @TheRealJon
Summary by CodeRabbit