Skip to content

Commit

Permalink
added 'requires' description to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robserm authored and stempler committed Nov 27, 2024
1 parent 37501d4 commit b836a4d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,25 @@ platform {

Providing a feature ID is mandatory, but *name* and *version* may be omitted (the version defaults to the platform feature version). `plugin` and `bundle` can be used synonymously inside the `feature` block, but when using `bundle` you may experience problems when used in inner closures.

The feature may include also other required features. See an example below how to define such dependencies:

```groovy
platform {
// define a feature
feature(id: 'platform.restclient', name: 'REST client dependencies', version: '1.0.0') {
requires (
featureName: "required.feature.name",
version: "1.0.0",
match: "greaterOrEqual"
)
//... the rest of the feature definition
}
}
```

### Local dependencies

You can easily add local JARs to the platform. **If the JAR is not an OSGi bundle yet**, you have add it on its own and at least provide **symbolicName** and **version**:
Expand Down

0 comments on commit b836a4d

Please sign in to comment.