[
https://issues.apache.org/jira/browse/MNG-7038?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17711268#comment-17711268
]
ASF GitHub Bot commented on MNG-7038:
-------------------------------------
michael-o commented on code in PR #1061:
URL: https://github.com/apache/maven/pull/1061#discussion_r1163863120
##########
api/maven-api-core/src/main/java/org/apache/maven/api/Project.java:
##########
@@ -116,6 +116,16 @@ default String getId() {
*/
boolean isRootProject();
+ /**
+ * Gets the root directory of the project, which is the parent directory
containing the {@code .mvn} directory
+ * or flagged with {@code root="true"}. If there's no such file, an {@code
IllegalStateException} will be thrown.
Review Comment:
The last sentence duplicates the `@throws`
##########
api/maven-api-core/src/main/java/org/apache/maven/api/Session.java:
##########
@@ -101,6 +92,17 @@ public interface Session {
@Nonnull
Path getTopdir();
+ /**
+ * Gets the root directory of the session, which is the root directory for
the topdir project.
+ * If there's no such file, an {@code IllegalStateException} will be
thrown.
Review Comment:
same here
##########
maven-core/src/main/java/org/apache/maven/project/MavenProject.java:
##########
@@ -1679,4 +1681,13 @@ public ProjectBuildingRequest
getProjectBuildingRequest() {
public void setProjectBuildingRequest(ProjectBuildingRequest
projectBuildingRequest) {
this.projectBuilderConfiguration = projectBuildingRequest;
}
+
+ /**
+ * @since 4.0.0
+ * @return the rootdir for this project
+ * @throws IllegalArgumentException if the rootdir cannot be found
Review Comment:
Here it is IAE but else ISE?
> Introduce public property to point to a root directory of (multi-module)
> project
> --------------------------------------------------------------------------------
>
> Key: MNG-7038
> URL: https://issues.apache.org/jira/browse/MNG-7038
> Project: Maven
> Issue Type: Improvement
> Reporter: Envious Guest
> Priority: Major
> Fix For: Issues to be reviewed for 4.x
>
>
> This is a request to expose a property *maven.multiModuleProjectDirectory*
> which is currently internal (or introduce a brand new one with analogous
> functionality).
> * For a single-module project, its value should be same as *project.basedir*
> * For multi-module project, its value should point to a project.basedir of a
> root module
> Example:
> multi-module // located at /home/me/sources
> +- module-a
> +- module B
> Sample multi-module/pom.xml:
> {{<project>}}
> {{ <parent>}}
> {{ <groupId>com.acme</groupId>}}
> {{ <artifactId>corp-parent</artifactId>}}
> {{ <version>1.0.0-RELEASE</version>}}
> {{ </parent>}}
> {{ <groupId>com.acme</groupId>}}
> {{ <artifactId>multi-module</artifactId>}}
> {{ <version>0.5.2-SNAPSHOT</version>}}
> {{ <modules>}}
> {{ <module>module-a</module>}}
> {{ <module>module-b</module>}}
> {{ </modules>}}
> {{</project>}}
> The property requested should return /home/me/sources/multi-module,
> regardless of whether it's referenced in any of the child modules (module-a,
> module-b) or in multi-module.
> Note that multi-module itself has parent (e.g. installed in a local
> repository), so the new property should be smart enough to detect it and
> still point to /home/me/sources/multi-module instead of the local repository
> where the corp-parent is installed.
> The use-case for such a property could be to have a directory for combined
> report of static analysis tools. Typical example - jacoco combined coverage
> reports.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
