You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "hboutemy (via GitHub)" <gi...@apache.org> on 2023/06/04 08:07:43 UTC
[GitHub] [maven] hboutemy opened a new pull request, #1145: MNG-5789 document goals execution order
hboutemy opened a new pull request, #1145:
URL: https://github.com/apache/maven/pull/1145
https://issues.apache.org/jira/browse/MNG-5987
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] rmannibucau commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "rmannibucau (via GitHub)" <gi...@apache.org>.
rmannibucau commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1222965368
##########
maven-plugin-api/src/main/mdo/plugin.mdo:
##########
@@ -24,9 +24,10 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other tools may geenrated it or it could even be hand-written.
Review Comment:
The two cases I met and think are ok were:
1. Don't depend on the maven build stack for a simple plugin (= very few primitives as param) - this one was "old"
2. No maven in the build pipeline (saw plain makefile like to build "build tools" and some sbt case)
That said no issue to drop the extra part, just wanted to highlight we might not want to enforce the usage of a maven plugin and keep it as a contract since it is what it is by design.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy closed pull request #1145: [MNG-5789] Document goals execution order
Posted by "hboutemy (via GitHub)" <gi...@apache.org>.
hboutemy closed pull request #1145: [MNG-5789] Document goals execution order
URL: https://github.com/apache/maven/pull/1145
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1222935817
##########
maven-plugin-api/src/site/apt/index.apt:
##########
@@ -25,15 +25,21 @@
Maven Plugin API
- The API for plugins - composed of goals implemented by Mojos - development.
+ The API for plugins - composed of goals implemented by Mojos - development:
+
+ * goal code extends {{{./apidocs/org/apache/maven/plugin/AbstractMojo.html}<<<AbstractMojo>>> base class}} that implements {{{./apidocs/org/apache/maven/plugin/Mojo.html}<<<Mojo>>> interface}},
+
+ * {{{./apidocs/org/apache/maven/plugin/logging/Log.html}<<<Log>>> interface}} provides easy logging for the goal.
+
+ []
A plugin is described in a {{{./plugin.html}<<<META-INF/maven/plugin.xml>>> plugin descriptor}},
- generally generated from plugin sources using {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}}.
+ generally generated from plugin sources using {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}} (other tools may generate it, or it could eventually be hand-written).
Review Comment:
Should that one be removed too to be consistent ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on pull request #1145: MNG-5789 document goals execution order
Posted by "hboutemy (via GitHub)" <gi...@apache.org>.
hboutemy commented on PR #1145:
URL: https://github.com/apache/maven/pull/1145#issuecomment-1575670118
yes, let's go step by step: MNG-5987 then MNG-7804
notice that adding a public XML element in pom.xml creates an incompatibility: it'll have to be done as XML attribute
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "hboutemy (via GitHub)" <gi...@apache.org>.
hboutemy commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1222909210
##########
maven-plugin-api/src/main/mdo/plugin.mdo:
##########
@@ -24,9 +24,10 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other tools may geenrated it or it could even be hand-written.
Review Comment:
ok, "is generally generated from plugin sources using maven-plugin-plugin" is sufficient, no absolute need to add more: I'll remove the extra explanation
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1222921104
##########
maven-plugin-api/src/main/mdo/plugin.mdo:
##########
@@ -24,9 +24,10 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other tools may geenrated it or it could even be hand-written.
Review Comment:
> It happens the file is written manually and it is regularly parsed by other tools (rarely generated I guess, it is either the official generator or manually done).
Do you have in mind valid use cases for hand-writing the plugin descriptor ? If people write their plugins in a different language such as groovy, kotlin, Scala or whatever... ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "hboutemy (via GitHub)" <gi...@apache.org>.
hboutemy commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1226105568
##########
maven-plugin-api/src/site/apt/index.apt:
##########
@@ -25,15 +25,21 @@
Maven Plugin API
- The API for plugins - composed of goals implemented by Mojos - development.
+ The API for plugins - composed of goals implemented by Mojos - development:
+
+ * goal code extends {{{./apidocs/org/apache/maven/plugin/AbstractMojo.html}<<<AbstractMojo>>> base class}} that implements {{{./apidocs/org/apache/maven/plugin/Mojo.html}<<<Mojo>>> interface}},
+
+ * {{{./apidocs/org/apache/maven/plugin/logging/Log.html}<<<Log>>> interface}} provides easy logging for the goal.
+
+ []
A plugin is described in a {{{./plugin.html}<<<META-INF/maven/plugin.xml>>> plugin descriptor}},
- generally generated from plugin sources using {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}}.
+ generally generated from plugin sources using {{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}} (other tools may generate it, or it could eventually be hand-written).
Review Comment:
yes, sure
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] rmannibucau commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "rmannibucau (via GitHub)" <gi...@apache.org>.
rmannibucau commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1221145499
##########
maven-plugin-api/src/main/mdo/plugin.mdo:
##########
@@ -24,9 +24,10 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other tools may geenrated it or it could even be hand-written.
Review Comment:
It happens the file is written manually and it is regularly parsed by other tools (rarely generated I guess, it is either the official generator or manually done).
But this is a public API since it is part of the contract of plugins, the tools don't encapsulate anything while it must be published IMHO so structure has to be stable even if it can evolve (additions and things like that are ok for ex for such cases).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #1145: MNG-5789 document goals execution order
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on code in PR #1145:
URL: https://github.com/apache/maven/pull/1145#discussion_r1221092114
##########
maven-plugin-api/src/main/mdo/plugin.mdo:
##########
@@ -24,9 +24,10 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other tools may geenrated it or it could even be hand-written.
Review Comment:
geenrated -> generated
##########
maven-plugin-api/src/main/mdo/plugin.mdo:
##########
@@ -24,9 +24,10 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other tools may geenrated it or it could even be hand-written.
Review Comment:
I'm not really about adding the sentence that `other tools may generated it or it could even be hand-written`. Maybe I'm wrong, but I'm not aware of any such tools. If there's none, this becomes irrelevant.
Also from an API point of view, I would consider the xml plugin descriptor an internal technical feature, rather than a user facing API, as really, users don't manipulate or see it. It just happens to be generated by the tooling provided by maven and understood by maven itself.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on pull request #1145: MNG-5789 document goals execution order
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on PR #1145:
URL: https://github.com/apache/maven/pull/1145#issuecomment-1575664382
Note that I'd like to add a `<priority>` element of the `<execution>`. This field already exists and is handled, we just need to make it public in the model.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org