[gatein-issues] [JBoss JIRA] (GTNPORTAL-3210) Quickstart names in the POM files are often are not clear across products
[
https://issues.jboss.org/browse/GTNPORTAL-3210?page=com.atlassian.jira.pl...
]
Peter Palaga commented on GTNPORTAL-3210:
-----------------------------------------
Hi Sande,
bq. We often have quickstarts with the same name in different repositories.
I am ready to help but I doubt any of the Portal quickstarts bears a name that would not
be unique within JDF. All our quickstarts' names contain either "portlet" or
"portal" which makes the link to the origin repository explicit enough, IMO.
bq. When you run {{mvn clean install '-Pdefault,!complex-dependencies'}} from the
root directory of the quickstarts, it often is not clear which quickstart is compiling.
It is a feature/limitation of Maven we all have to live with. I have that problem often
myself by some projects, but with Portal quickstarts, I take care that {{<name>}}
and {{<artifactId>}} strongly resemble each other: in most cases,
{{artifactId.equals(name.toLowerCase().replace(" ", "-"))}}. I am
ready to enforce this generally without exceptions if you say it helps.
bq. As described in the CONTRIBUTING.md file, we would like the <name> in the
quickstart pom.xml file to follow the template: JBoss <target-product> Quickstart:
<quickstart-name> < - optional-subfolder-name>
As you already know, I am using {{<name>}} to generate the title line in
{{README.md}} files and the descriptor for JBoss Tools/JBoss Central. Especially JBoss
Central is very sensitive about the length of the name. I wonder how you generate the
descriptors for JBoss Tools? If I change the {{<name>}} in POMs to what you propose,
I would have to find another place for storing the original simple name.
If you insist on your proposal, I'd add this to the set of changes I am doing for JDF
on top of our default release, see
https://github.com/gatein/gatein-portal-quickstart/blob/master/src/build/...
Quickstart names in the POM files are often are not clear across
products
-------------------------------------------------------------------------
Key: GTNPORTAL-3210
URL: https://issues.jboss.org/browse/GTNPORTAL-3210
Project: GateIn Portal
Issue Type: Bug
Security Level: Public(Everyone can see)
Reporter: Sande Gilda
Assignee: Peter Palaga
Now that we aggregate quickstarts from different repositories and for different products,
we need a better way to identify them. We often have quickstarts with the same name in
different repositories.
When you run `mvn clean install '-Pdefault,!complex-dependencies'` from the root
directory of the quickstarts, it often is not clear which quickstart is compiling.
As described in the CONTRIBUTING.md file, we would like the <name> in the
quickstart pom.xml file to follow the template:
JBoss <target-product> Quickstart: <quickstart-name> < -
optional-subfolder-name> where target-product is the Target Product metadata specified
in the README.md file, quickstart-name is the quickstart folder name, and
optional-subfolder-name is the name of any nested subfolder containing a pom.xml file.
This means the Portal cdi-generic-portlet would be:
<name>JBoss JPP Quickstart: cdi-generic-portlet</name>
I know you have concerns about changing this and we can certainly discuss it. :-)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira