Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(crds)!: consistently use message field instead of error field #1542

Merged
merged 5 commits into from
Feb 27, 2024

Conversation

krancour
Copy link
Member

@krancour krancour commented Feb 27, 2024

@jessesuen and I agreed quite some time ago that status subresources would use Message fields instead of Error fields to preserve the potential for communicating things that are not strictly errors.

We have, since then, consistently used Message in new status subresource types, but Stages and Warehouses were still using Error.

This was a low-hanging consistency improvement that I wanted to make before breaking changes become more difficult.

cc @rbreeze or @rpelczar, although there are open issues for surfacing info from these fields, I can not find any place in the UI where the field names that are changing are currently referenced. You might want to double-check me.

There are no other changes in this PR.

Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
Copy link

netlify bot commented Feb 27, 2024

Deploy Preview for docs-kargo-akuity-io ready!

Name Link
🔨 Latest commit 5799d33
🔍 Latest deploy log https://app.netlify.com/sites/docs-kargo-akuity-io/deploys/65dd267d99d2520007764b61
😎 Deploy Preview https://deploy-preview-1542.kargo.akuity.io
📱 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 site configuration.

@krancour krancour enabled auto-merge February 27, 2024 00:03
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

Attention: Patch coverage is 16.66667% with 10 lines in your changes are missing coverage. Please review.

Project coverage is 30.05%. Comparing base (62969c1) to head (5799d33).

Files Patch % Lines
pkg/api/v1alpha1/types.pb.go 0.00% 4 Missing ⚠️
internal/controller/stages/stages.go 0.00% 3 Missing ⚠️
internal/api/types/v1alpha1/types.go 33.33% 2 Missing ⚠️
internal/controller/warehouses/warehouses.go 50.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1542   +/-   ##
=======================================
  Coverage   30.05%   30.05%           
=======================================
  Files         194      194           
  Lines       20072    20072           
=======================================
  Hits         6033     6033           
  Misses      13781    13781           
  Partials      258      258           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

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

Without taking the details of the UI into account, this looks good to me.

💯 for consistency.

@krancour krancour added this pull request to the merge queue Feb 27, 2024
Merged via the queue into akuity:main with commit 5912e5a Feb 27, 2024
22 of 23 checks passed
@krancour krancour deleted the krancour/error-to-message branch February 27, 2024 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants