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

[RHELC-1635] State action in special pkg removal report msgs #1297

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bocekm
Copy link
Member

@bocekm bocekm commented Jul 10, 2024

Customers have been confused when seeing the messages, not knowing what should they do.

Jira Issues:

Checklist

  • PR has been tested manually in a VM (either author or reviewer)
  • Jira issue has been made public if possible
  • [RHELC-] or [HMS-] is part of the PR title
  • GitHub label has been added to help with Release notes
  • PR title explains the change from the user's point of view
  • Code and tests are documented properly
  • The commits are squashed to as few commits as possible (without losing data)
  • When merged: Jira issue has been updated to Release Pending if relevant

@bocekm bocekm added the tests/sanity PR ready to run the sanity test suit. Equivalent to `/packit test --labels sanity`. label Jul 10, 2024
@bocekm bocekm requested a review from pr-watson July 10, 2024 16:47
@has-bot
Copy link
Member

has-bot commented Jul 10, 2024

/packit test --labels sanity


Comment generated by an automation.

@bocekm bocekm added the kind/feature New feature or request label Jul 10, 2024
Copy link

codecov bot commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.83%. Comparing base (52054d3) to head (2e5ac98).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1297   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files          55       55           
  Lines        4756     4756           
  Branches      836      836           
=======================================
  Hits         4558     4558           
  Misses        112      112           
  Partials       86       86           
Flag Coverage Δ
centos-linux-7 91.02% <100.00%> (ø)
centos-linux-8 91.95% <100.00%> (ø)
centos-linux-9 92.00% <100.00%> (ø)

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.

Copy link
Contributor

@pr-watson pr-watson left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Customers have been confused when seeing the messages, not knowing what
should they do.
@bocekm bocekm force-pushed the state-action-in-special-pkgs-removal-msg branch from c6fb81a to 2e5ac98 Compare July 11, 2024 12:53
@bocekm
Copy link
Member Author

bocekm commented Jul 11, 2024

@pr-watson, I've reworded the messages a bit. Please take a look.

EDIT: I can imagine a couple of ways to improve the messages even further - I've laid the ideas out at https://issues.redhat.com/browse/RHELC-1637. They can be worked on in another PR.

),
diagnosis=message,
remediations=("Check that the system runs correctly without the packages after the conversion."),
Copy link
Member Author

Choose a reason for hiding this comment

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

@bookwar, do you see a better action the user can take?

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
remediations=("Check that the system runs correctly without the packages after the conversion."),
remediations="Check that the system runs correctly without the packages after the conversion.",

),
remediations=(
"We do a conversion dry-run (yum transaction validation) later on as part of the pre-conversion"
" analysis. If the dry-run fails, try removing the packages listed above manually."
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to add there also command customer can use?

Copy link
Member

Choose a reason for hiding this comment

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

The first sentence in the remediations seems to be they would be a better fit in the diagnosis, I belive... Right now, it doesn't seem that they are fitting in the remediations correctly.

I tend to think that remediation would be a step-to-step on how to solve the problem, not really an explanation of why it failed.

Do we want to add there also command customer can use?

If we know what command can be used, I don't see why not. Would be useful

Comment on lines 153 to +154
id="SPECIAL_PACKAGES_NOT_REMOVED",
title="Special packages not removed",
description="Special packages which could not be removed",
diagnosis=message,
title="Some packages cannot be removed",
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should also update the id? It feels strange that in the id we call them as "special" and in the title is just "some packages"

Copy link
Member

@r0x0d r0x0d left a comment

Choose a reason for hiding this comment

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

Looks good, only some small comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature New feature or request tests/sanity PR ready to run the sanity test suit. Equivalent to `/packit test --labels sanity`.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants