Sync kubex charts from automation-controller main @ 12d1c03#104
Conversation
There was a problem hiding this comment.
CONTENT OF THIS REVIEW IS AI GENERATED
Overall assessment: This is a small, automated documentation-only sync PR that removes pre-release/early-access warnings and strips the "early access releases" qualifier from the kubex-crds chart description. The changes are mechanically correct, but they quietly remove all user-facing maturity signals without any accompanying indication that the charts have actually graduated to stable/GA status. No functional or Helm-rendered content is affected.
Risk level: Low
Critical issues:
- None
Major issues:
- None
Minor issues:
- Maturity-signal removal without status declaration (
Getting-Started.md,kubex-crds/README.md): Both files drop their pre-release/early-adoption advisories and cross-references tokubex-automation-controller. Users arriving fresh will have no context about prior early-access status or the production-grade alternative. Coordinate with a release note or CHANGELOG entry, or replace the warnings with a brief "GA as of vX.Y" statement. - Version/appVersion mismatch (
Chart.yaml): The description now implies general availability, butappVersion: v0.1still reads as pre-release/alpha. If this is a GA promotion, bumpappVersion; if not, keep at least a softened qualifier in the description to stay consistent.
DRY improvement opportunities:
- None in this changeset.
Suggested next steps:
- Confirm whether the chart is intentionally graduating to stable/GA. If yes, update
appVersioninChart.yaml(and consider bumpingversion) and add a brief GA announcement line in the README/Getting-Started docs. - If
kubex-automation-controllerremains the recommended production chart, add a lightweight "See also" cross-reference in the READMEs so users can discover the production path without stumbling over it later. - Consider adding a
CHANGELOGentry (or a GitHub Release) linked to this commit so the intent of removing early-access language is clearly documented for downstream consumers.
| @@ -2,9 +2,6 @@ | |||
|
|
|||
| This guide walks through installing the chart and validating the current CRD-based automation flow. | |||
|
|
|||
There was a problem hiding this comment.
CONTENT OF THIS REVIEW IS AI GENERATED
[Severity: Minor] [Confidence: Medium]
Location: charts/kubex-automation-engine/docs/Getting-Started.md:4–6
Issue: The [!IMPORTANT] pre-release / redirect-to-production notice is being removed without a replacement or a changelog note.
Why it matters: Users who discover this chart for the first time (e.g. via Artifact Hub, search engines, or cached documentation) will no longer receive any signal that it was previously considered pre-release or that a more production-ready alternative exists (kubex-automation-controller). If the intent is to graduate the chart to GA/stable, the removal is correct — but the docs give no indication of that status change, which can leave returning users confused about whether the maturity level changed or the warning was simply lost.
Suggested fix:
- If the chart is now production-ready, add a brief note (e.g. in an "About" or "Status" section) confirming GA status so the removal looks intentional.
- If the chart is still pre-release but the warning is being removed for other reasons, consider replacing it with a lighter notice (e.g. a GitHub release badge or a status line in the README) to preserve user expectation-setting.
| @@ -2,7 +2,5 @@ | |||
|
|
|||
| This chart installs the CustomResourceDefinitions (CRDs) required for Kubex Automation Engine. | |||
|
|
|||
There was a problem hiding this comment.
CONTENT OF THIS REVIEW IS AI GENERATED
[Severity: Minor] [Confidence: Medium]
Location: charts/kubex-crds/README.md:4–5
Issue: The early-adoption / redirect-to-controller advisory is removed without any replacement note.
Why it matters: Identical concern as in Getting-Started.md: users reading only the CRDs chart README now have no guidance about its maturity level or the relationship to the kubex-automation-controller chart. Losing cross-chart discovery hints can lead to sub-optimal deployment choices (e.g. adopting kubex-crds + kubex-automation-engine in production without realising a more stable path existed).
Suggested fix:
- Coordinate the documentation update with any release-notes or
CHANGELOGentry that declares the chart as stable/GA. - If the
kubex-automation-controllerchart remains the production recommendation, keep a brief "See also" cross-reference rather than removing the notice entirely.
| name: kubex-crds | ||
| description: CRDs for Kubex Automation Engine early access releases | ||
| description: CRDs for Kubex Automation Engine | ||
| version: 1.0.0 |
There was a problem hiding this comment.
CONTENT OF THIS REVIEW IS AI GENERATED
[Severity: Minor] [Confidence: High]
Location: charts/kubex-crds/Chart.yaml:4
Issue: version remains 1.0.0 and appVersion remains v0.1 after the description change.
Why it matters: The description change ("early access releases" → general release wording) implies a maturity shift. If this chart is now considered stable/GA, the appVersion v0.1 still signals early/alpha software. Conversely, if it is still v0.1, removing the "early access" language from the description creates a mismatch between the artifact metadata and the actual release state, which can mislead operators and dependency consumers (e.g. Helm operators that parse appVersion for policy enforcement).
Suggested fix:
- If the chart is graduating to a stable release, bump
appVersion(and optionallyversion) to reflect that. - If the chart remains at
v0.1, consider keeping or softening (rather than fully removing) the "early access" qualifier in the description to keep description and version consistent.
This PR was created automatically to sync managed Kubex chart content.
Source commit:
12d1c03Managed chart scope:
charts/kubex-automation-enginecharts/kubex-crds