[ https://issues.apache.org/jira/browse/SLING-8078?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16678397#comment-16678397 ]
ASF GitHub Bot commented on SLING-8078: --------------------------------------- simonetripodi edited a comment on issue #16: SLING-8078 - New Analyser task which is able to detect Export-Package dependencies between regions URL: https://github.com/apache/sling-slingfeature-maven-plugin/pull/16#issuecomment-436665191 Just to give you more background, Given a generic Feature File where `api-regions` names are arbitrary: ```{ "id":"org.apache.sling:slingfeature-maven-plugin-test:1.0.0-SNAPSHOT", "bundles":[ { "id":"org.apache.aries.versioning:org.apache.aries.versioning.checker:0.3.1", "start-level":"20" } ], "api-regions:JSON|false": [ { "name": "my-global", "exports": [ "org.apache.aries.versioning.check" ] }, { "name": "my-deprecated", "exports": [ "org.objectweb.asm" ] } ] }``` the plugin can be now configured in order to handle that two regions: ```<configuration> <scans> <scan> <includes>**/*.json</includes> <includeTasks>api-regions-dependencies</includeTasks> <contextConfiguration> <exporting-apis>my-global</exporting-apis> <hiding-apis>my-deprecated</hiding-apis> </contextConfiguration> </scan> </scans> </configuration> ``` and produces expected error: ```[ERROR] Bundle 'org.apache.aries.versioning:org.apache.aries.versioning.checker:0.3.1' (defined in feature 'org.apache.sling:slingfeature-maven-plugin-test:1.0.0-SNAPSHOT') declares 'org.apache.aries.versioning.check' in the 'Export-Package' header, enlisted in the 'my-global' region, which requires 'org.objectweb.asm' package that is in the 'my-deprecated' region``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org > New Analyser task which is able to detect Export-Package dependencies between > regions > ------------------------------------------------------------------------------------- > > Key: SLING-8078 > URL: https://issues.apache.org/jira/browse/SLING-8078 > Project: Sling > Issue Type: New Feature > Components: Feature Model, Maven Plugins and Archetypes > Affects Versions: Feature Model Analyser 0.2.0 > Reporter: Simone Tripodi > Assignee: David Bosschaert > Priority: Major > Fix For: Feature Model Analyser 0.2.2 > > > It may be helpful users have the need to define a {{deprecated}} region in > order to mark which APIs don't have to be exposed to end users, a new > Analyser Task implementation will help to detect if {{global}} exported APIs > don't have {{uses}} dependencies to APIs that are declared in the > {{deprecated}} region. > i.e. given a feature: > {noformat} > ... > [ > { > "name": "global" > "exports": ["org.osgi.util.function"] > }, > { > "name": "deprecated", > "exports": ["org.objectweb.asm"] > } > ] > ... > {noformat} > and a bundle declares the OSGi header in the Manifest as below: > {noformat} > Export-Package: org.osgi.util.function;uses:="org.objectweb.asm" > {noformat} > the new Analyser Task implementation will detect that "violation" > {noformat} > Bundle 'org.osgi:org.osgi.util.function:1.0.0', defined in feature > 'org.apache.sling.testing:org.apache.sling.testing.apiregions:1.0.0', > declares 'org.osgi.util.function' in the 'Export-Package' header which > requires 'org.objectweb.asm' package that is in the 'deprecated' region > {noformat} > PR is coming -- This message was sent by Atlassian JIRA (v7.6.3#76005)