[MNG-7706] Deprecate 'localRepository' parameter expression #1009
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
|
Ironically, ITs report this: |
maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
Outdated
Show resolved
Hide resolved
slawekjaranowski
approved these changes
Feb 21, 2023
...n-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedCoreExpressionValidator.java
Outdated
Show resolved
Hide resolved
slawekjaranowski
approved these changes
Feb 22, 2023
|
Before this is merged, we need to do something with ITs:
|
laeubi
reviewed
Feb 23, 2023
| @@ -40,7 +40,7 @@ | |||
| * <tr><td><code>session</code></td> <td></td> <td>the actual {@link MavenSession}</td></tr> | |||
| * <tr><td><code>session.*</code></td> <td>(since Maven 3)</td><td></td></tr> | |||
| * <tr><td><code>localRepository</code></td> <td></td> | |||
| * <td>{@link MavenSession#getLocalRepository()}</td></tr> | |||
| * <td>{@link MavenSession#getLocalRepository()} DEPRECATED: Avoid use of {@link org.apache.maven.artifact.repository.ArtifactRepository} type. If you need access to local repository, switch to '${repositorySystemSession}' expression and get LRM from it instead.</td></tr> | |||
There was a problem hiding this comment.
I think some Plugin deleopers might have no clue what LRM is, probabbly also give a link to the wiki/jira/... that explains some details.
There was a problem hiding this comment.
Updated javadoc, added link to the issue. Issue updated with "how to fix" https://issues.apache.org/jira/browse/MNG-7706
cstamas
added a commit
to cstamas/maven-integration-testing
that referenced
this pull request
Feb 23, 2023
The MNG-7706 deprecates ancient ArtifactRepository type use to
get access to local repository, and issues warning as for any
other deprecated Mojo parameters.
But alas, in ITs the MNG-5576 completely unrelated IT there is
an assertion to have WARNING-free log. This IT uses the
IT-plugins/IT-plugin-expression EvalMojo, that in turn
uses the deprecated `${localRepository}` parameter (but
does not use it). Result is, Maven 3.9.1 emits a WARNING
about use of deprecated parameter and the IT fails.
Further inspection shows, that while EvalMojo injects
ArtifactRepository for local repository, there is only
one IT that actually uses it, the MNG-4305, but even that
one is interested in basedir of the local repository only.
So to say, the use of deprecated ArtifactRepository is
not needed at all.
Fix:
* change EvalMojo to not expose in context the localRepository
(w/ type ArtifactRepository), but a new expression `localRepositoryBasedir`
only, that is injected in non-deprecated way.
* adjusted MNG-4305 to use new epxression instead to use object reflection in
template to get basedir from ArtifactRepository
* This makes the originally failing MNG-5576 pass, as warning due EvalMojo
is gone.
See
https://issues.apache.org/jira/browse/MNG-7706
apache/maven#1009
cstamas
added a commit
to apache/maven-integration-testing
that referenced
this pull request
Feb 23, 2023
The MNG-7706 deprecates ancient ArtifactRepository type use to get access to local repository, and issues warning as for any other deprecated Mojo parameters.
But alas, in ITs the MNG-5576 completely unrelated IT there is an assertion to have WARNING-free log. This IT uses the IT-plugins/IT-plugin-expression EvalMojo, that in turn uses the deprecated `${localRepository}` parameter (but does not use it). Result is, Maven 3.9.1 emits a WARNING about use of deprecated parameter and the IT fails.
Further inspection shows, that while EvalMojo injects ArtifactRepository for local repository, there is only one IT that actually uses it, the MNG-4305, but even that one is interested in basedir of the local repository only. So to say, the use of deprecated ArtifactRepository type is not needed at all.
Fix:
* change EvalMojo to not expose in context the localRepository (w/ type ArtifactRepository), but a new expression `localRepositoryBasedir` only, that is injected in non-deprecated way (in real life repoSysSession would be injected, but in IT we keep all super-safe and use Object types).
* adjusted MNG-4305 to use new epxression instead to use object reflection in template to get basedir from ArtifactRepository
* This makes the originally failing MNG-5576 pass, as warning due EvalMojo is gone.
See
https://issues.apache.org/jira/browse/MNG-7706
apache/maven#1009
This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706
cstamas
force-pushed
the
maven-3.9.x-MNG-7706-deprecate-localRepository-expr
branch
from
b7fc8d8
to
f55f5cb
Compare
cstamas
deleted the
maven-3.9.x-MNG-7706-deprecate-localRepository-expr
branch
cstamas
added a commit
to cstamas/maven
that referenced
this pull request
Feb 23, 2023
) This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706
cstamas
added a commit
that referenced
this pull request
Feb 23, 2023
…1012) This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo. --- https://issues.apache.org/jira/browse/MNG-7706
|
In practical terms, what does this mean for people with |
|
As description says "This PR deprecates the 'localRepository' mojo parameter expression". Has nothing to do with |
|
Moreover, please use mailing lists for these sort of questions, not old/closed pull requests https://maven.apache.org/mailing-lists.html |
|
I upgrade to 3.9.x, I see a warning, and I have a single place where I use "localRepository". Maybe make messages more clear, make release notes more clear, and upgrade your communication channels to something more usable. |
|
This is a project maintained by volunteers, hence you can contribute as well! Feel free to produce as many quality patches and other improvements project-wise as you like! We will be glad to review them 😺 |
Closed
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.
This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo.
https://issues.apache.org/jira/browse/MNG-7706