Skip to content

Commit c093a53

Browse files
authored
Make jakarta.annotation-api compile scope so SmallRyeConfig can be used without any extra set up (#1193)
1 parent 7903a3c commit c093a53

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ image:https://img.shields.io/maven-central/v/io.smallrye.config/smallrye-config?
1010
= SmallRye Config
1111

1212
*SmallRye Config* is a library that provides a way to configure applications, frameworks and containers. It is used
13-
in applications servers like https://wildfly.org/[WildFly] and https://openliberty.io[Open Liberty], or frameworks
14-
like https://quarkus.io[Quarkus]. It can also be used completely standalone in any Java application, which makes it a
15-
very flexible library.
13+
in applications servers like https://wildfly.org/[WildFly], https://openliberty.io[Open Liberty] and
14+
https://tomee.apache.org[TomEE], or frameworks like https://quarkus.io[Quarkus]. It can also be used completely
15+
standalone in any Java application, which makes it a very flexible library.
1616

1717
It follows the https://github.com/eclipse/microprofile-config/[MicroProfile Config] specification to provide
1818
the initial config foundations and expands with it own concepts to cover a wide range of use cases observed in the

documentation/src/main/docs/index.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ hide:
77
# SmallRye Config
88

99
**SmallRye Config** is a library that provides a way to configure applications, frameworks and containers. It is used
10-
in applications servers like [WildFly](https://wildfly.org/) and [Open Liberty](https://openliberty.io), or frameworks
11-
like [Quarkus](https://quarkus.io). It can also be used completely standalone in any Java application, which makes it a
12-
very flexible library.
10+
in applications servers like [WildFly](https://wildfly.org/), [Open Liberty](https://openliberty.io) and
11+
[TomEE](https://tomee.apache.org) or frameworks like [Quarkus](https://quarkus.io). It can also be used completely
12+
standalone in any Java application, which makes it a very flexible library.
1313

1414
It follows the [MicroProfile Config](https://github.com/eclipse/microprofile-config/) specification to provide
1515
the initial config foundations and expands with it own concepts to cover a wide range of use cases observed in the
@@ -53,6 +53,17 @@ And retrieve a `SmallRyeConfig` instance with:
5353
SmallRyeConfig config = ConfigProvider.getConfig().unwrap(SmallRyeConfig.class);
5454
```
5555

56+
!!! info
57+
58+
The `SmallRyeConfig` instance will be created and registered to the context class loader if no such configuration
59+
is already created and registered.
60+
61+
Or build your own:
62+
63+
```java
64+
SmallRyeConfig config = new SmallRyeConfigBuilder().build();
65+
```
66+
5667
!!! info
5768

5869
`SmallRyeConfig` is the entry point to all the config capabilities provided by SmallRye Config.

implementation/pom.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
<dependency>
3636
<groupId>jakarta.annotation</groupId>
3737
<artifactId>jakarta.annotation-api</artifactId>
38-
<scope>provided</scope>
3938
</dependency>
4039
<dependency>
4140
<groupId>io.smallrye.common</groupId>

0 commit comments

Comments
 (0)