Skip to content

✨ (pre-flight check) Improve error message - #2006

Merged
anik120 merged 1 commit into
operator-framework:mainfrom
anik120:improve-preflight-check-error-message
Jun 11, 2025
Merged

✨ (pre-flight check) Improve error message#2006
anik120 merged 1 commit into
operator-framework:mainfrom
anik120:improve-preflight-check-error-message

Conversation

@anik120

Copy link
Copy Markdown
Member

Description

The line "failed to get release state using client-only dry-run" is too jargon heavy, and meaningless for the end user.
This PR replaces the error message with a more user friendly text.

Reviewer Checklist

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

@anik120
anik120 requested a review from a team as a code ownerJune 3, 2025 19:56
@netlify

netlifyBot commented Jun 3, 2025

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commita9f2af6
🔍 Latest deploy loghttps://app.netlify.com/projects/olmv1/deploys/6849da15633d700008519924
😎 Deploy Previewhttps://deploy-preview-2006--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.

@anik120
anik120force-pushed the improve-preflight-check-error-message branch from 6b10130 to 1513098CompareJune 3, 2025 19:58

@camilamacedo86camilamacedo86 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.

I think it might broke the downstream tests :-(
Last time I think they were matching the string

@tmshort@jianzhangbjz for you be aware of the change.

But I either liked more the new message 👍

Comment threadinternal/operator-controller/applier/helm.go
@anik120
anik120force-pushed the improve-preflight-check-error-message branch from 1513098 to 1fc3d52CompareJune 3, 2025 20:07
@codecov

codecovBot commented Jun 3, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 69.26%. Comparing base (8f81c23) to head (a9f2af6).
Report is 8 commits behind head on main.

Files with missing linesPatch %Lines
internal/operator-controller/applier/helm.go0.00%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #2006 +/- ##
==========================================
+ Coverage 69.17% 69.26% +0.08% 
==========================================
Files 79 79 Lines 7037 7051 +14 ==========================================
+ Hits 4868 4884 +16 + Misses 1887 1885 -2 
Partials 282 282 
FlagCoverage Δ
e2e42.94% <0.00%> (-0.06%)⬇️
unit60.17% <0.00%> (+0.12%)⬆️

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.

@camilamacedo86camilamacedo86 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.

👍

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

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

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-ciopenshift-ciBot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 10, 2025
tmplRel, err := h.renderClientOnlyRelease(ctx, ext, chart, values, post)
if err != nil {
return fmt.Errorf("failed to get release state using client-only dry-run: %w", err)
return fmt.Errorf("error rendering bundle for pre-authorization checks: %w", err)

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.

Suggested change
returnfmt.Errorf("error rendering bundle for pre-authorization checks: %w", err)
returnfmt.Errorf("error rendering content for pre-authorization checks: %w", err)

Maybe content for when we have more types like Helm and Bundle regestry/v1
WDYT?

Otherwise, LGTM

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Sure that works too 👍🏽

The line "failed to get release state using client-only dry-run" is too
jargon heavy, and meaningless for the end user.
This PR replaces the error message with a more user friendly text.
@anik120
anik120force-pushed the improve-preflight-check-error-message branch from 1fc3d52 to a9f2af6CompareJune 11, 2025 19:33
@openshift-ciopenshift-ciBot removed the lgtm Indicates that a PR is ready to be merged. label Jun 11, 2025
@openshift-ci

Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@anik120
anik120 merged commit 0c9f0b5 into operator-framework:mainJun 11, 2025
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@anik120@joelanford@camilamacedo86