On 1/30/2013 5:27 AM, Peter Klügl wrote:
> Hi,
>
> On 30.01.2013 00:03, Marshall Schor wrote:
>> Hi,
>>
>> I compared the source-release zip (unzipped) with the svn export of the tag -
>> looks good.
>>
>> There's one difference:  The svn has a .project file included in the
>> ExampleProject.  It has some special build setup that might be "required" to
>> make the ExampleProject work with TextMarker:
>>
>>    <buildSpec>
>>      <buildCommand>
>>        <name>org.eclipse.dltk.core.scriptbuilder</name>
>>        <arguments>
>>        </arguments>
>>      </buildCommand>
>>    </buildSpec>
>>    <natures>
>>      <nature>org.apache.uima.textmarker.ide.nature</nature>
>>    </natures>
>>
>> If this is required, then it should have been in the source zip package, but
>> wasn't...
>
> No, it is not required for TextMarker. This project is an exemplary TextMarker
> project and therefore bound to Eclipse. 

That's fine.  I used the wrong word, "required".  I meant, did you mean to
include this example as part of the release?   It sounds like, "yes".

So it needs to be in the source-release.zip package.  I'm guessing it's being
excluded by the normal (default) apache-wide assembly script for source-release
packages, which you can see inside this jar:
http://repo1.maven.org/maven2/org/apache/apache/resources/apache-source-release-assembly-descriptor/1.0.3/apache-source-release-assembly-descriptor-1.0.3.jar

The relevant parts are:

        <!-- NOTE: Most of the following excludes should not be required
             if the standard release process is followed. This is because the
             release plugin checks out project sources into a location like
             target/checkout, then runs the build from there. The result is
             a source-release archive that comes from a pretty clean directory
             structure.

             HOWEVER, if the release plugin is configured to run extra goals
             or generate a project website, it's definitely possible that some
             of these files will be present. So, it's safer to exclude them.
        -->

        <!-- IDEs -->
       
<exclude>%regex[(?!((?!${project.build.directory}/)[^/]+/)*src/)(.*/)?maven-eclipse\.xml]</exclude>
       
<exclude>%regex[(?!((?!${project.build.directory}/)[^/]+/)*src/)(.*/)?\.project]</exclude>

The last line drops files with name .project.

To get these into your source-release, I think you have to either:
1) figure out an override for the standard set of excludes, or
2) figure out how to add this omitted file to the zip (a little ant script would
do the trick, I think)
3) rename the file to something that won't be excluded, and then have a
post-install fixup for the examples project,
...  etc.

> I created this project for users to have an example on how TextMarker projects
> are sturctured and I am also using it in the documentation, e.g., because it
> also contains files for test-driven developement/backtesting.
>
>> If not required, then perhaps it should be deleted from svn.  (I also see a
>> .buildpath checked into SVN - is that required for this project?).
>
> I really like to keep this project in SVN. Users should be able to "download"
> (checkout) this project in the TextMarker Workbench. I am also in favor of
> providing it somewhere for download.
>
> The .buildpath is part of a TextMarker project.
>
> Maybe we can place it somewhere different in SVN?
No, this is a fine place.  THe only issue is that the .project is getting
excluded by default from the source-release.  Just need to figure out a way to
get it added back :-).

-Marshall

Reply via email to