[
https://issues.apache.org/jira/browse/SLING-8078?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16681508#comment-16681508
]
ASF GitHub Bot commented on SLING-8078:
---------------------------------------
bosschaert commented 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-437375351
Hi @simonetripodi @cziegeler I was playing with the new plugin a little and
found out that the same code that is checked in can also handle the following
maven configuration:
```
<scan>
<includes>**/*.json</includes>
<includeTasks>api-regions-dependencies</includeTasks>
<!-- taskConfiguration is a String, Properties map -->
<taskConfiguration>
<!-- each key represents an AnalyserTask ID -->
<api-regions-dependencies>
<!-- can use keyname-textvalue syntax too -->
<exporting-apis>my-global</exporting-apis>
<hiding-apis>my-deprecated</hiding-apis>
</api-regions-dependencies>
</taskConfiguration>
</scan>
```
So we can also use named keys for the task configuration. I think this is a
little bit nicer since we already use named keys to address the task and it's
more compact.
As I mentioned - no need to change the code for this; it already works. It's
just a matter of documenting/style. I'll update
https://github.com/apache/sling-slingfeature-maven-plugin/README.md with some
documentation about this goal.
----------------------------------------------------------------
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:
[email protected]
> 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: slingfeature-maven-plugin 1.0.0, 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)
