Uploaded image for project: 'RHEL Conversions'
  1. RHEL Conversions
  2. RHELC-1093

Sync messages from insights to convert2rhel

XMLWordPrintable

    • Testable

      In  https://issues.redhat.com/browse/RHELC-1091 we are going to implement messages in the insights server.  We are going to do that as

      • it will allow them to be modified more frequently than in convert2rhel.
      • the messages can differ between convert2rhel and insights

      However, this leads to us having similar messages hosted in two locations with the potential to get out of sync when wording is changed in one or the other.

      To fix this, we should implement a way to sync messages from the insights server code to convet2rhel.  We can then run that sync at least once per release cycle, shortly before dev freeze.

      Acceptance criteria:

      Prerequisites from RHELC-1094

      These are stretch goals for https://issues.redhat.com/browse/RHELC-1094 If they are not as part of that ticket,  they will need to be done here.

      • Move messages into a json file
        • Format a dictionary keyed on ACTION_ID:MESSAGE_ID
        • Value is a set of fields from insights that we will use to construct the convert2rhel message (insights will probably have four fields: title, description, diagnosis, remediation.  convet2rhel displays those as a single message.
      • convert2rhel code changes
        • In convert2rhel.action.report.summary()
          • read the messages from the json file

      Main criteria

      • Write a script (or github action) to sync the messages from insights
        • retrieve the messages from where they are stored for insights (a git repo maybe?)
          • Need to coordinate with dank and pwayper to make sure the templated messages are hosted in a way that we can retrieve them.
        • open a pull request that updates the json file with the new messages.
        • We should include a way to override some messages as they may need to be different for the cli than in insights.  Perhaps a second json file which has entries for anything that we override.  The data should both include the message to override with and the last synced version from insights.  This way, we can tell someone to manually update the message if the insights version has changed.
        • Add running this script, reviewing, and approving the PR it generates, and making any manual message changes that are needed to a list of tasks that need to happen before freeze in every development cycle. (The list might not exist yet.  Consult with Eric.

            Unassigned Unassigned
            tkuratom@redhat.com Toshio Kuratomi
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: