1:56 p.m.
Hi all.
The License Header check is on the way. But I have some thoughts that I
would like to share and ask your opinion.
- I'm using the Checkstyle API to verify for the License Header. Even
using RegexpHeader, the check is made line by line. " Checks the header
of a source file against a header that contains a regular expression for
each line of the source header."
(http://checkstyle.sourceforge.net/config_header.html)
- We instruct the users to use some specific headers:
http://www.jboss.org/jdf/quickstarts/get-involved/
- We also instructs the users to use the following ide templates/format
but these templates differ from what we propose:
https://github.com/jboss/ide-config/blob/master/eclipse/jboss-java-templa...
- Some quickstarts comming from other repos have their header modified
like on this commit:
https://github.com/jboss-jdf/jboss-as-quickstart/commit/605d877b38f280a32...
So I ask you what should be better to use on the quickstarts tools ?
1 - Make IDE/JDF Site similar and *refactor all* non-compliant
quickstarts? (Inflexible)
2 - Use another plugin http://code.google.com/p/maven-license-plugin/
that has the feature to include many distinguished and valid headers
(Less restrictive)
3 - Manually check if the first lines of the file contains the following
patterns: "JBoss, Home of Professional Open Source" and "Licensed under
the Apache License" (Almost without restrictions on format)
Until what point should we be too restrictive or not for this checking ?
Thanks.
Em 14/02/13 18:25, Rafael Benevides escreveu:
Hi all,
JDF is growing each day. As a consequence, keep the quickstarts
consistent is becoming a hard work.
To mitigate this and help the maintenance of the quickstart and also
to help the contributors to see if their quickstarts are ready to
review, we are planning and starting the development of a tooling for
quickstart automation.
This tool will make use of some other well know and opensource
projects like PMD (pmd.sf.net), checkstyke (checkstyle.sf.net), Maven
Enforcer plugin, etc to attend the following requirements:
* Validating quickstart POM files:
o Check for the License header (checkstyle headers
<http://checkstyle.sourceforge.net/config_header.html>)
o Check for proper spacing and Indentation (trycheckstyle
<http://checkstyle.sourceforge.net/>-whitespace rule
<http://checkstyle.sourceforge.net/config_whitespace.html>andindentation
rule
<http://checkstyle.sourceforge.net/config_misc.html#Indentation>)
o Check and verify if all quickstarts are using the same/latest
BOM versions
o Verify is it using the standard properties names (We will
provide the standard properties name)
o Check for non bom versions (and identify if we should create a
new BOM)
o Check javascript and css versions
o Check for duplicate properties and dependencies
o Check the pom.xml elements order
o Create scripts to update versions (quickstart, boms, etc)
o When a new quickstart is added, if it has a pom.xml file, make
sure the <module> is defined in one of the following profiles:
default, requires-postgres, complex-dependencies,
requires-full, requires-xts, non-maven.
* Validating quickstart README files:
o Check for the required metadata tags in README (Level, Author,
Target Product, etc)
o Verify the quickstart name in the README matches the folder
name and the project name
* Validating quickstart source code
o Check the quantity of comments in the code (evaluatePMD
<http://pmd.sourceforge.net/pmd-5.0.2/rules/java/comments.html>)
* General validation (desired):
o If a quickstart with a source other than the current
repository is modified, create an alert of some sort so we can
notify the upstream repository of the change.
o When we update a BOM property version in the quickstarts, we
need to make the same changes in the archetypes.
o Also, if there is a code fix in the kitchensink or
kitchensink-ear, we need to make the same fix in the archetype
code and check other quickstarts based on the same archetype
to see if they need the fixes applied.
If you have some comments, I will be glad to hear you.
Thanks
--
Rafael Benevides | Senior Software Engineer
Red Hat Brazil
+55-61-9269-6576
Better technology. Faster innovation. Powered by community collaboration.
See how it works at redhat.com