-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
gnodet
merged 3 commits into
apache:master
from
yuehcw:feature/MNG-7902-sort-plugins-validation-report
May 23, 2024
Merged
[MNG-7902] Sort plugins in the validation report #1510
gnodet
merged 3 commits into
apache:master
from
yuehcw:feature/MNG-7902-sort-plugins-validation-report
May 23, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gnodet
requested changes
May 21, 2024
maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultPluginValidationManager.java
Outdated
Show resolved
Hide resolved
maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultPluginValidationManager.java
Outdated
Show resolved
Hide resolved
… statements and remove unnecessary comment
maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultPluginValidationManager.java
Outdated
Show resolved
Hide resolved
slawekjaranowski
approved these changes
May 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
gnodet
approved these changes
May 23, 2024
I hope we can cherry-pick it to maven-3.x |
slawekjaranowski
pushed a commit
that referenced
this pull request
Jun 5, 2024
slawekjaranowski
pushed a commit
that referenced
this pull request
Jun 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 theDefaultPluginValidationManager
class. The plugins are sorted usingMap.Entry.comparingByKey(String.CASE_INSENSITIVE_ORDER)
before they are logged.Following this checklist to help us incorporate your
contribution quickly and easily:
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.
[MNG-XXX] SUMMARY
,where you replace
MNG-XXX
andSUMMARY
with the appropriate JIRA issue.[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.
mvn clean verify
to make sure basic checks pass. A more thorough check willbe performed on your pull request automatically.
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.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.