You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2024/06/01 20:24:06 UTC

(maven-project-info-reports-plugin) 01/01: [MPIR-451] Rename "Dependency Information" to "Maven Coordinates"

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch MPIR-451
in repository https://gitbox.apache.org/repos/asf/maven-project-info-reports-plugin.git

commit 36f4a2bcc9740567d81c496113a011818d2ba5b7
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sat Jun 1 22:20:41 2024 +0200

    [MPIR-451] Rename "Dependency Information" to "Maven Coordinates"
    
    This closes #67
---
 .../report/projectinfo/DependencyInformationReport.java   |  2 +-
 src/main/resources/project-info-reports.properties        |  4 ++--
 src/main/resources/project-info-reports_cs.properties     |  2 --
 src/main/resources/project-info-reports_de.properties     |  4 ++--
 src/main/resources/project-info-reports_es.properties     |  4 ++--
 src/main/resources/project-info-reports_fr.properties     |  4 ++--
 src/main/resources/project-info-reports_ru.properties     |  4 ++--
 src/main/resources/project-info-reports_sv.properties     |  2 --
 src/main/resources/project-info-reports_zh_CN.properties  |  2 --
 src/site/apt/index.apt.vm                                 | 15 +++++++++++++--
 10 files changed, 24 insertions(+), 19 deletions(-)

diff --git a/src/main/java/org/apache/maven/report/projectinfo/DependencyInformationReport.java b/src/main/java/org/apache/maven/report/projectinfo/DependencyInformationReport.java
index d1d67a5..dad6bd9 100644
--- a/src/main/java/org/apache/maven/report/projectinfo/DependencyInformationReport.java
+++ b/src/main/java/org/apache/maven/report/projectinfo/DependencyInformationReport.java
@@ -28,7 +28,7 @@ import org.apache.maven.reporting.MavenReportException;
 import org.codehaus.plexus.i18n.I18N;
 
 /**
- * Generates code snippets to be added to build tools.
+ * Generates code snippets of the Maven coordinates to be added to build tools.
  *
  * @author <a href="mailto:simonetripodi@apache.org">Simone Tripodi</a>
  * @since 2.5
diff --git a/src/main/resources/project-info-reports.properties b/src/main/resources/project-info-reports.properties
index 96c4085..2845c90 100644
--- a/src/main/resources/project-info-reports.properties
+++ b/src/main/resources/project-info-reports.properties
@@ -127,8 +127,8 @@ report.dependency-convergence.stats.conflicting                    = Number of v
 report.dependency-convergence.stats.snapshots                      = Number of SNAPSHOT artifacts (NOS):
 report.dependency-convergence.stats.modules                        = Number of modules:
 report.dependency-convergence.title                                = Dependency Convergence
-report.dependency-info.name                                        = Dependency Information
-report.dependency-info.title                                       = Dependency Information
+report.dependency-info.name                                        = Maven Coordinates
+report.dependency-info.title                                       = Maven Coordinates
 report.dependency-info.description                                 = This document describes how to include this project as a dependency using various dependency management tools.
 report.index.nodescription                                         = There is currently no description associated with this project.
 report.index.title                                                 = About
diff --git a/src/main/resources/project-info-reports_cs.properties b/src/main/resources/project-info-reports_cs.properties
index 2767ab5..c1332e5 100644
--- a/src/main/resources/project-info-reports_cs.properties
+++ b/src/main/resources/project-info-reports_cs.properties
@@ -116,8 +116,6 @@ report.dependency-convergence.stats.readyrelease.success           = \u00dasp\u0
 report.dependency-convergence.stats.snapshots                      = Po\u010det sn\u00edmkov\u00fdch artefakt\u016f (NOS):
 report.dependency-convergence.stats.modules                        = Po\u010det podprojekt\u016f:
 report.dependency-convergence.title                                = Reaktor sbli\u017eov\u00e1n\u00ed z\u00e1vislost\u00ed
-report.dependency-info.name                                        = Informace o z\u00e1vislosti
-report.dependency-info.title                                       = Informace o z\u00e1vislosti
 report.dependency-info.description                                 = Tento dokument popisuje, jak zahrnout tento projekt jako z\u00e1vislost pomoc\u00ed r\u016fzn\u00fdch n\u00e1stroj\u016f z\u00e1vislost \u0159\u00edzen\u00ed.
 report.index.nodescription                                         = Pro tento projekt nen\u00ed p\u0159ipojen \u017e\u00e1dn\u00fd popis.
 report.index.title                                                 = O projektu
diff --git a/src/main/resources/project-info-reports_de.properties b/src/main/resources/project-info-reports_de.properties
index 47c1b7a..54bd989 100644
--- a/src/main/resources/project-info-reports_de.properties
+++ b/src/main/resources/project-info-reports_de.properties
@@ -127,8 +127,8 @@ report.dependency-convergence.stats.conflicting                    = Anzahl Arte
 report.dependency-convergence.stats.snapshots                      = Anzahl SNAPSHOT-Artefakte (NOS):
 report.dependency-convergence.stats.modules                        = Anzahl Module:
 report.dependency-convergence.title                                = Konvergenz der Abh\u00e4ngigkeiten
-report.dependency-info.name                                        = Abh\u00e4ngigkeiten Information
-report.dependency-info.title                                       = Abh\u00e4ngigkeiten Information
+report.dependency-info.name                                        = Maven-Koordinaten
+report.dependency-info.title                                       = Maven-Koordinaten
 report.dependency-info.description                                 = In diesem Dokument sind Informationen enthalten, wie dieses Projekt als Abh\u00e4ngigkeit zu anderen Dependency-Management-Tools hinzugef\u00fcgt werden kann.
 report.index.nodescription                                         = Derzeit existiert keine Beschreibung f\u00fcr dieses Projekt.
 report.index.title                                                 = Willkommen bei
diff --git a/src/main/resources/project-info-reports_es.properties b/src/main/resources/project-info-reports_es.properties
index fa82f10..ccbe75d 100644
--- a/src/main/resources/project-info-reports_es.properties
+++ b/src/main/resources/project-info-reports_es.properties
@@ -117,8 +117,8 @@ report.dependency-convergence.stats.readyrelease.success           = \u00c9xito
 report.dependency-convergence.stats.snapshots                      = N\u00famero de Artefactos SNAPSHOT  (NDS):
 report.dependency-convergence.stats.modules                        = N\u00famero de Subproyectos:
 report.dependency-convergence.title                                = Convergencia de Dependencias en el Reactor
-report.dependency-info.name                                        = Informaci\u00f3n de Dependencias
-report.dependency-info.title                                       = Informaci\u00f3n de Dependencias
+report.dependency-info.name                                        = Coordenadas de Maven
+report.dependency-info.title                                       = Coordenadas de Maven
 report.dependency-info.description                                 = Este documento describe c\u00f3mo incluir este proyecto como una dependencia utilizando distintas herramientas de gesti\u00f3n de dependencias.
 report.index.nodescription                                         = A\u00FAn no se ha escrito una descripci\u00F3n para este proyecto.
 report.index.title                                                 = Bienvenido a
diff --git a/src/main/resources/project-info-reports_fr.properties b/src/main/resources/project-info-reports_fr.properties
index 247c1b6..5988915 100644
--- a/src/main/resources/project-info-reports_fr.properties
+++ b/src/main/resources/project-info-reports_fr.properties
@@ -117,8 +117,8 @@ report.dependency-convergence.stats.readyrelease.success           = Succ\u00e8s
 report.dependency-convergence.stats.snapshots                      = Nombre d'artefacts SNAPSHOT (NOS)\u202f:
 report.dependency-convergence.stats.modules                        = Nombre de sous-projets\u202f:
 report.dependency-convergence.title                                = R\u00e9action de la convergence des d\u00e9pendances
-report.dependency-info.name                                        = Informations de d\u00e9pendance
-report.dependency-info.title                                       = Informations de d\u00e9pendance
+report.dependency-info.name                                        = Coordonnu00e9es de Maven
+report.dependency-info.title                                       = Coordonnu00e9es de Maven
 report.dependency-info.description                                 = Ce document pr\u00e9sente la mani\u00e8re d'ajouter ce projet en tant que d\u00e9pendance avec diff\u00e9rents outils de gestion des d\u00e9pendances.
 report.index.nodescription                                         = Il n'y a aucune description actuellement li\u00e9e \u00e0 ce projet.
 report.index.title                                                 = Bienvenue dans le projet
diff --git a/src/main/resources/project-info-reports_ru.properties b/src/main/resources/project-info-reports_ru.properties
index 63168c6..0e536f6 100644
--- a/src/main/resources/project-info-reports_ru.properties
+++ b/src/main/resources/project-info-reports_ru.properties
@@ -127,8 +127,8 @@ report.dependency-convergence.stats.conflicting                    = \u041A\u043
 report.dependency-convergence.stats.snapshots                      = \u041A\u043E\u043B\u0438\u0447\u0435\u0441\u0442\u0432\u043E SNAPSHOT-\u0430\u0440\u0442\u0435\u0444\u0430\u043A\u0442\u043E\u0432 (NOS):
 report.dependency-convergence.stats.modules                        = \u041A\u043E\u043B\u0438\u0447\u0435\u0441\u0442\u0432\u043E \u043C\u043E\u0434\u0443\u043B\u0435\u0439 \u043F\u0440\u043E\u0435\u043A\u0442\u0430:
 report.dependency-convergence.title                                = \u0421\u0445\u043E\u0434\u0438\u043C\u043E\u0441\u0442\u044C \u0417\u0430\u0432\u0438\u0441\u0438\u043C\u043E\u0441\u0442\u0435\u0439
-report.dependency-info.name                                        = \u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u0417\u0430\u0432\u0438\u0441\u0438\u043C\u043E\u0441\u0442\u044F\u0445
-report.dependency-info.title                                       = \u0418\u043D\u0444\u043E\u0440\u043C\u0430\u0446\u0438\u044F \u043E \u0417\u0430\u0432\u0438\u0441\u0438\u043C\u043E\u0441\u0442\u044F\u0445
+report.dependency-info.name                                        = \u041A\u043E\u043E\u0440\u0434\u0438\u043D\u0430\u0442\u044B\u0020\u041C\u0430\u0432\u0435\u043D\u0430
+report.dependency-info.title                                       = \u041A\u043E\u043E\u0440\u0434\u0438\u043D\u0430\u0442\u044B\u0020\u041C\u0430\u0432\u0435\u043D\u0430
 report.dependency-info.description                                 = \u0412 \u0434\u0430\u043D\u043D\u043E\u043C \u0440\u0430\u0437\u0434\u0435\u043B\u0435 \u043E\u043F\u0438\u0441\u044B\u0432\u0430\u0435\u0442\u0441\u044F, \u043A\u0430\u043A \u043F\u043E\u0434\u043A\u043B\u044E\u0447\u0438\u0442\u044C \u0434\u0430\u043D\u043D\u044B\u0439 \u043F\u0440\u043E\u0435\u043A\u0442 \u043A \u0434\u0440\u0443\u0433\u0438\u043C \u043F\u0440\u043E\u0435\u043A\u0442\u0430\u043C \u0432 \u043A\u0430\u [...]
 report.index.nodescription                                         = \u0412 \u043D\u0430\u0441\u0442\u043E\u044F\u0449\u0438\u0439 \u043C\u043E\u043C\u0435\u043D\u0442 \u043E\u043F\u0438\u0441\u0430\u043D\u0438\u0435 \u043F\u0440\u043E\u0435\u043A\u0442\u0430 \u043E\u0442\u0441\u0443\u0442\u0441\u0442\u0432\u0443\u0435\u0442.
 report.index.title                                                 = \u0421\u043F\u0440\u0430\u0432\u043A\u0430
diff --git a/src/main/resources/project-info-reports_sv.properties b/src/main/resources/project-info-reports_sv.properties
index e6d4bcc..80c0f11 100644
--- a/src/main/resources/project-info-reports_sv.properties
+++ b/src/main/resources/project-info-reports_sv.properties
@@ -112,8 +112,6 @@ report.dependency-convergence.stats.readyrelease.success           = Framg\u00e5
 report.dependency-convergence.stats.snapshots                      = Antal SNAPSHOT artefakter (Number of SNAPSHOTs, NOS):
 report.dependency-convergence.stats.modules                        = Antal underprojekt:
 report.dependency-convergence.title                                = Beroendekonvergens fr\u00e5n Reactor
-report.dependency-info.name                                        = Beroendeinformation
-report.dependency-info.title                                       = Beroendeinformation
 report.dependency-info.description                                 = Detta dokument beskriver hur man l\u00e4gger till ett beroende till detta projekts huvudartefakt med olika beroendehanteringsverktyg.
 report.index.nodescription                                         = Det finns ingen beskrivning f\u00f6r detta projekt.
 report.index.title                                                 = Om
diff --git a/src/main/resources/project-info-reports_zh_CN.properties b/src/main/resources/project-info-reports_zh_CN.properties
index 21b6026..1f51d7d 100644
--- a/src/main/resources/project-info-reports_zh_CN.properties
+++ b/src/main/resources/project-info-reports_zh_CN.properties
@@ -127,8 +127,6 @@ report.dependency-convergence.stats.conflicting                    = \u6709\u724
 report.dependency-convergence.stats.snapshots                      = \u5FEB\u7167\u7248\u672C\u7684artifact\u6570\u76EE(NOS):
 report.dependency-convergence.stats.modules                        = \u5B50\u9879\u76EE\u7684\u6570\u76EE:
 report.dependency-convergence.title                                = \u4F9D\u8D56\u4E00\u81F4\u6027
-report.dependency-info.name                                        = \u4F9D\u8D56\u4FE1\u606F
-report.dependency-info.title                                       = \u4F9D\u8D56\u4FE1\u606F
 report.dependency-info.description                                 = \u672C\u6587\u6863\u63CF\u8FF0\u4E86\u5982\u4F55\u4F7F\u7528\u5404\u79CD\u4F9D\u8D56\u9879\u7BA1\u7406\u5DE5\u5177\u5C06\u6B64\u9879\u76EE\u4F5C\u4E3A\u4F9D\u8D56\u9879\u3002
 report.index.nodescription                                         = \u76EE\u524D\u6CA1\u6709\u5BF9\u672C\u9879\u76EE\u7684\u63CF\u8FF0\u3002
 report.index.title                                                 = \u6B22\u8FCE\u6765\u5230
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 9fa0ba9..b5c390f 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -44,8 +44,8 @@ ${project.name}
    * {{{./dependency-convergence-mojo.html}project-info-reports:dependency-convergence}} is used to generate the
    Project Dependency Convergence report for (reactor) builds.
 
-   * {{{./dependency-info-mojo.html}project-info-reports:dependency-info}} is used to generate code snippets to
-   be added to build tools.
+   * {{{./dependency-info-mojo.html}project-info-reports:dependency-info}} is used to generate code snippets
+   of the Maven coordinates to be added to build tools.
 
    * {{{./dependency-management-mojo.html}project-info-reports:dependency-management}} is used to generate the
    Project Dependency Management report.
@@ -79,6 +79,17 @@ ${project.name}
 
    * {{{./summary-mojo.html}project-info-reports:summary}} is used to generate the Project Summary report.
 
+* Upcoming Incompatibility Notice
+
+  With the next major version (4.0) mojos and output filenames will change for consistency alignment
+  To make you aware of that, see the following table for the upcoming changes:
+
+*-----------------------*-------------------------*----------------------------*------------------------------*
+|| Goal Name            || New Goal Name          || Output name               || New Output Name             |
+*-----------------------+-------------------------+----------------------------+------------------------------+
+| <<<dependency-info>>> | <<<maven-coordinates>>> | <<<dependency-info.html>>> | <<<maven-coordinates.html>>> |
+*-----------------------+-------------------------+----------------------------+------------------------------+
+
 * Usage
 
   General instructions on how to use the Project Info Reports Plugin can be found on the {{{./usage.html}usage page}}. Some more