jackrabbit-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jukka Zitting (Resolved) (JIRA)" <j...@apache.org>
Subject [jira] [Resolved] (JCR-3073) Explicit management of public API
Date Tue, 27 Sep 2011 21:30:45 GMT

     [ https://issues.apache.org/jira/browse/JCR-3073?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Jukka Zitting resolved JCR-3073.

    Resolution: Fixed
      Assignee: Jukka Zitting

We now have package-info and clirr settings for both jackrabbit-api and jackrabbit-jcr-commons.
Resolving as fixed.
> Explicit management of public API
> ---------------------------------
>                 Key: JCR-3073
>                 URL: https://issues.apache.org/jira/browse/JCR-3073
>             Project: Jackrabbit Content Repository
>          Issue Type: Improvement
>          Components: jackrabbit-api, jackrabbit-jcr-commons
>            Reporter: Jukka Zitting
>            Assignee: Jukka Zitting
>             Fix For: 2.3.0
> I'd like to start using the Clirr Maven plugin [1] to make sure that we don't accidentally
break backwards compatibility in our public APIs, most notably in jackrabbit-api and jackrabbit-jcr-commons.
> Also, we should start explicitly managing the API versions exposed as a part of the OSGi
package metadata. Currently all our public packages simply get the latest project version
as their version number, but it would be better if the version was explicitly managed and
only updated if the API actually changes. To do this I propose we use @Version annotations
from the bnd tool on the package-info.java files in all packages considered a part of our
public API.
> The Clirr plugin should flag all changes made in the API, so we have an easy way to tell
which packages need to have their version numbers updated.
> [1] http://mojo.codehaus.org/clirr-maven-plugin/

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


View raw message