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

[MNG-7902] Sort plugins in the validation report #1510

Merged

Conversation

yuehcw
Copy link
Contributor

@yuehcw yuehcw commented May 17, 2024

Summary

This pull request addresses the JIRA issue MNG-7902. The goal of this change is to enhance the readability and usability of the validation report by sorting the plugins in a case-insensitive manner. Currently, the report outputs the content of a set of plugins without sorting them, which can result in a random order, making it difficult for users to locate specific entries or identify patterns.

Changes Made

Added sorting logic: Implemented a sorting mechanism to order plugins case-insensitively in the validation report.
Updated reportSessionCollectedValidationIssues function: Modified this function to include the sorting logic for plugins before they are logged.

Why This Change Is Necessary

By sorting the plugins in the validation report, developers can easily scan through the list to find specific entries or identify changes. This enhancement improves the readability and usability of the report, especially in scenarios where users need to review or troubleshoot plugin configurations.

How the Change Was Implemented

The sorting logic was added to the reportSessionCollectedValidationIssues function in the DefaultPluginValidationManager class. The plugins are sorted using Map.Entry.comparingByKey(String.CASE_INSENSITIVE_ORDER) before they are logged.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MNG-XXX] SUMMARY,
    where you replace MNG-XXX and SUMMARY with the appropriate JIRA issue.
  • Also format the first line of the commit message like [MNG-XXX] SUMMARY.
    Best practice is to use the JIRA issue title in both the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

… statements and remove unnecessary comment
Copy link
Member

@slawekjaranowski slawekjaranowski left a comment

Choose a reason for hiding this comment

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

LGTM

@gnodet gnodet added this to the 4.0.0-beta-4 milestone May 23, 2024
@gnodet gnodet merged commit dd96794 into apache:master May 23, 2024
13 checks passed
@slawekjaranowski
Copy link
Member

I hope we can cherry-pick it to maven-3.x

slawekjaranowski pushed a commit that referenced this pull request Jun 5, 2024
Co-authored-by: Yueh Chun Wu <[email protected]>

(cherry picked from commit dd96794)
slawekjaranowski pushed a commit that referenced this pull request Jun 5, 2024
Co-authored-by: Yueh Chun Wu <[email protected]>

(cherry picked from commit dd96794)
@gnodet gnodet modified the milestones: 4.0.0-beta-4, 4.0.0 Jul 6, 2024
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.

3 participants