Hi,
Am 02.03.2017 um 21:57 schrieb Marshall Schor:
> Java API change reporting: some improvements to consider (but not blockers).
>
> It looks like just one project (ruta-core) has this activated. What about
> other
> projects that define user-accessable APIs, like ruta-core-ext, and maybe
> others?
>
> It probably would also be good (especially if you have multiple projects) to
> aggregate these together so the interested user can see all the api changes
> via
> some top-level thing, like issuesFixed.
>
> Also, you might want to say in the README or RELEASE_NOTES where to look for
> the
> api change report. For some reason, this didn't make it into the
> source-release.zip, even though I see in build-from-sources, that it is copied
> from the ruta-core/target/api-change-report to ruta-core/api-change-report.
I actually have added a mention and a link to RELEASE_NOTES but removed
it again.
The question is: What is the user-accessible API?
I think its only the two packages in ruta-core:
org.apache.uima.ruta.{engine,descriptor}
(and the maven args in ruta-maven-plugin)
This is what I checked for with the old semver enforcer. All the other
classes in the other packages should not be directly accessed.
Mainly, the user creates a configured RutaEngine AE, creates an
descriptor with the factories, or uses some static method in Ruta.java
The report contains useful information about what changed, but it also
creates the impression that a lot of API is broken all the time. Thus, I
did not want to highlight it too much.
I like to open ruta more towards a java lib with an API and I am
improving the interfaces so that they become more stable, but right now
we are not there yet and public stuff changes all the time.
If the api report does not only summarize actual API changes but also
implementation changes, I probably should also add the report for the
other artifacts. Or if not, then I should maybe restrict the report to
the two packages.
Advice/opinions are welcome :-)
Best,
Peter
> -Marshall
>
>
> On 3/2/2017 4:21 AM, Peter Klügl wrote:
>> Hi,
>>
>> the first release candidate of Apache UIMA Ruta v2.6.0 is ready for voting.
>> This release replaces the planned 2.5.1 release and is also not
>> compatible with UIMA 3.0.0.
>>
>> Major changes in this release:
>>
>> UIMA Ruta Language and Analysis Engine:
>> * Annotation expressions can be restricted using feature matches and
>> conditions
>> * Several new configuration parameters for RutaEngine
>> * Experimental features to optimize internal indexing (for experienced
>> users)
>> * Minimal support of feature structures in feature match expressions
>> * API change report for ruta-core
>> * Typesystem descriptors with JCasGen classes are located in separate
>> artifact
>> * Implementation of RutaBasic is located in separate artifact
>> * Many bug fixes and improvements, especially for label expressions
>>
>> UIMA Ruta Workbench:
>> * Direct debugging of launched scripts in Java is supported
>> * Improved error messages in launcher
>> * Removed restriction of classpath size causing problems in launcher
>> * Deactivated noVM preference
>> * Changed UI to set annotation mode in views
>> * Launcher uses project encoding
>> * Bug fixes
>>
>>
>> Staging repository:
>> https://repository.apache.org/content/repositories/orgapacheuima-1124/
>>
>> SVN tag:
>> https://svn.apache.org/repos/asf/uima/ruta/tags/ruta-2.6.0
>>
>> Update site:
>> https://dist.apache.org/repos/dist/dev/uima/ruta-2.6.0-rc1/eclipse-update-site/ruta/
>>
>> Archive with all sources:
>> https://dist.apache.org/repos/dist/dev/uima/ruta-2.6.0-rc1/ruta-2.6.0-source-release.zip
>>
>> Overall 43 issues have been fixed for this release
>> (1 duplicates, 1 not a problem).
>> They can be found in the RELEASE_NOTES.html.
>>
>> ... and here:
>>
>> https://issues.apache.org/jira/issues/?jql=project%20%3D%20UIMA%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Reopened%2C%20Resolved%2C%20Closed)%20AND%20fixVersion%20%3D%202.6.0ruta%20AND%20component%20%3D%20ruta%20ORDER%20BY%20updated%20DESC%2C%20created%20DESC
>>
>> Please vote on release:
>>
>> [ ] +1 OK to release
>> [ ] 0 Don't care
>> [ ] -1 Not OK to release, because ...
>>
>> Thanks.
>>
>> Peter
>>
>>
