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

Add evaluation_failure_message to ruletypes #4433

Merged
merged 8 commits into from
Sep 12, 2024

Conversation

teodor-yanev
Copy link
Contributor

@teodor-yanev teodor-yanev commented Sep 10, 2024

Summary

Provide a brief overview of the changes and the issue being addressed.
Explain the rationale and any background necessary for understanding the changes.
List dependencies required by this change, if any.

This PR adds a new evaluation_failure_message field to our ruletypes.

Fixes #4348

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@teodor-yanev teodor-yanev self-assigned this Sep 10, 2024
@coveralls
Copy link

coveralls commented Sep 10, 2024

Coverage Status

coverage: 53.507% (-0.002%) from 53.509%
when pulling c3c9e61 on add-evaluation_failure_message-to-ruletypes
into 15955f7 on main.

@blkt blkt self-requested a review September 12, 2024 06:55
blkt
blkt previously approved these changes Sep 12, 2024
@eleftherias
Copy link
Contributor

Not blocking, but we had discussed renaming evaluation_failure_message to short_failure_message to more clearly differentiate it from the long details message in https://github.com/stacklok/minder-stories/issues/3

@teodor-yanev
Copy link
Contributor Author

Not blocking, but we had discussed renaming evaluation_failure_message to short_failure_message to more clearly differentiate it from the long details message in stacklok/minder-stories#3

Tanks for letting me know, I've renamed the components.

Copy link
Contributor

@eleftherias eleftherias left a comment

Choose a reason for hiding this comment

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

When I tried this out locally and set short_failure_message: This is a failure message in one of my rules, I still saw the default short message in the DB.

It's possible I'm doing something wrong, I'm going to test it again to verify.

pkg/api/protobuf/go/minder/v1/rule_types.go Outdated Show resolved Hide resolved
Copy link
Contributor

@eleftherias eleftherias left a comment

Choose a reason for hiding this comment

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

Thanks, I'm not sure what I was doing wrong, but it was definitely me doing something wrong because it works now.

@teodor-yanev teodor-yanev merged commit c139b0a into main Sep 12, 2024
23 checks passed
@teodor-yanev teodor-yanev deleted the add-evaluation_failure_message-to-ruletypes branch September 12, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add evaluation_failure_message to rule types
4 participants