incubator-odf-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Yegor Kozlov (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ODFTOOLKIT-290) Consolidate build of ODFToolkit sub-projects
Date Sun, 09 Oct 2011 12:00:30 GMT

    [ https://issues.apache.org/jira/browse/ODFTOOLKIT-290?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13123668#comment-13123668
] 

Yegor Kozlov commented on ODFTOOLKIT-290:
-----------------------------------------

I made an attempt to clean RAT warnings and keep it quiet across all sub-projects. See the
proposed patch. 

The RAT plugin is activated in the "pedantic" mode. To check everything run 

"mvn verify -Ppedantic" from the project root.

Summary of changes:

1. generator/schema2template

added ASF licence:
M      generator/schema2template/src/main/javadoc/overview.html
M      generator/schema2template/src/main/resources/examples/odf/odf-reference/output-files.vm
M      generator/schema2template/src/main/resources/examples/odf/odf-reference/odf-reference-template.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/output-files.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-attribute-template.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-styleset.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-elementbase-template.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-styleproperties.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-attribute-visitor.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-element-template.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-stylefamily.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-java/java-odfdom-element-visitor.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-python/output-files.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-python/pythontest.vm
M      generator/schema2template/src/main/resources/examples/odf/odfdom-python/test_main.py

RAT configuration with exclusions:
            <plugin>
                <groupId>org.apache.rat</groupId>
                <artifactId>apache-rat-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>src/main/resources/examples/odf/*.rng</exclude>
                        <exclude>src/test/resources/examples/odf/*.ref</exclude>
                    </excludes>
                </configuration>
            </plugin>

2. ODFDOM

added ASF licence:
M      odfdom/src/test/java/org/odftoolkit/odfdom/dom/example/WikiExampleTest.java
M      odfdom/src/test/java/org/odftoolkit/odfdom/doc/draw/OdfDrawImageTest.java
M      odfdom/src/codegen/resources/dom/template/output-files.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-attribute-template.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-styleset.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-elementbase-template.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-styleproperties.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-element-template.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-stylefamily.vm
M      odfdom/src/codegen/resources/dom/template/java-odfdom-element-visitor.vm
M      odfdom/src/main/java/org/odftoolkit/odfdom/pkg/OdfFileDom.java
M      odfdom/src/main/java/org/odftoolkit/odfdom/type/SignedZeroToHundredPercent.java
M      odfdom/src/main/java/org/odftoolkit/odfdom/type/OdfFieldDataType.java
M      odfdom/src/main/java/org/odftoolkit/odfdom/type/ZeroToHundredPercent.java
M      odfdom/src/main/java/org/odftoolkit/odfdom/type/NonNegativeDecimal.java
M      odfdom/src/main/java/org/odftoolkit/odfdom/type/ZeroToOneDecimal.java
M      odfdom/src/main/java/org/odftoolkit/odfdom/type/OdfDataType.java
M      odfdom/src/main/javadoc/doc-files/OpenDocument-v1.2-cd05-part1.html
M      odfdom/src/main/javadoc/overview.html

RAT configuration with exclusions:
            <plugin>
                <groupId>org.apache.rat</groupId>
                <artifactId>apache-rat-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>src/main/resources/OdfSpreadsheetDocument.ods</exclude>
                        <exclude>src/test/resources/**</exclude>
                        <exclude>src/codegen/resources/dom/*.rng</exclude>
                        <exclude>src/codegen/resources/pkg/*.rng</exclude>
                    </excludes>
                </configuration>
            </plugin>


3. Simple
RAT configuration with exclusions:
            <plugin>
                <groupId>org.apache.rat</groupId>
                <artifactId>apache-rat-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>src/test/resources/**</exclude>
                    </excludes>
                </configuration>
            </plugin>

4. XSLT-Runner

added ASF licence:
M      xslt-runner/schema.user.properties
M      xslt-runner/sample_xslt/dummy.dtd
M      xslt-runner/schema.properties

RAT configuration with exclusions:
 
        <plugin>
            <groupId>org.apache.rat</groupId>
            <artifactId>apache-rat-plugin</artifactId>
            <configuration>
                <excludes>
                    <exclude>manifest.mf</exclude>
                    <exclude>misc/odf-attribute-xref.ods</exclude>
                    <exclude>nbproject/**</exclude>
                </excludes>
            </configuration>
        </plugin>

5. XSLT-Runner-Task:

added ASF licence:
M      xslt-runner-task/ant.properties

RAT configuration with exclusions:
        <plugin>
            <groupId>org.apache.rat</groupId>
            <artifactId>apache-rat-plugin</artifactId>
            <configuration>
                <excludes>
                    <exclude>nbproject/**</exclude>
                </excludes>
            </configuration>
        </plugin>


6. Validator:

added ASF licence:
M      validator/src/main/webapp/META-INF/context.xml
M      validator/src/main/webapp/WEB-INF/web.xml

RAT configuration with exclusions:
            <plugin>
                <groupId>org.apache.rat</groupId>
                <artifactId>apache-rat-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>src/main/resources/schema/**</exclude>
                        <exclude>src/main/resources/META-INF/services/org.iso_relax.verifier.VerifierFactoryLoader</exclude>
                        <exclude>src/test/resources/testInvalidPkg3.odt</exclude>
                        <exclude>src/codegen/resources/pkg/*.rng</exclude>
                    </excludes>
                </configuration>
            </plugin>

This patch is a required pre-requisite to setup continuous integration in Jenkins. The command
to run will be

"mvn clean install -Ppedantic"

This will build and test all modules and check that all files are OK from RAT point of view.
If someone committed a file without ASF licence then Jenkins will choke and send and email
report to odf-dev.  

Regards,
Yegor

                
> Consolidate build of ODFToolkit sub-projects
> --------------------------------------------
>
>                 Key: ODFTOOLKIT-290
>                 URL: https://issues.apache.org/jira/browse/ODFTOOLKIT-290
>             Project: ODF Toolkit
>          Issue Type: Improvement
>            Reporter: Yegor Kozlov
>            Assignee: Devin Han
>         Attachments: ip.patch
>
>
> As discussed on the dev list, we need to adjust the cross-module dependencies to compile
against trunk instead of hardcoded ODFDOM 0.8.7, Taglets 0.8.7, etc.
> I made an attempt to consolidate Maven build and propose the following structure under
a parent POM:
> {code}
> pom.xml (root) (modules: taglets,generator,xlst-runner,xslt-runner-task,odfdom,validator,simple)
>      +---- taglets
>                  +-- pom.xml  (parent: root)
>      +---- generator
>                  +---- schema2template 
>                          +-- pom.xml  (parent: generator)
>                  +---- schema2template-maven-plugin 
>                          +-- pom.xml  (parent: generator: dependeny: schema2template)
>      +---- xlst-runner
>                  +-- pom.xml   (parent: root)
>      +---- xlst-runner
>                  +-- pom.xml   (parent: root)
>      +---- xlst-runner-task
>                  +-- pom.xml   (parent: root)
>      +---- odfdom
>                  +-- pom.xml   (parent: root dependeny: taglets)
>      +---- validator
>                  +-- pom.xml   (parent: root dependeny: odfdom)
>      +---- simple
>                  +-- pom.xml   (parent: root dependeny: odfdom)
> {code}
> Summary of changes:
>  1. All sub-projects inherit the parent POM. This allows us to build and test all components
in one go. 
>  2. As per http://www.apache.org/dev/publishing-maven-artifacts.html, the parent POM
inherits the Apache POM. 
>  3. I changed the groupId to "org.apache.odftoolkit". The Maven artifacts should fit
in the Apache namespace.
>  4. Initial version is 0.5-SNAPSHOT 
>  5. [IMPORTANT] To test the build I had to restore  OdfFileDom#getAutomaticStyles().
Please revert this change after applying changes from https://issues.apache.org/jira/browse/ODFTOOLKIT-49
> Regards,
> Yegor

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message