Skip to content

Commit e43d4a5

Browse files
committed
Sync documentation of main branch
1 parent 29d95e3 commit e43d4a5

File tree

4 files changed

+41
-59
lines changed

4 files changed

+41
-59
lines changed

_generated-doc/main/infra/quarkus-all-build-items.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8235,7 +8235,7 @@ _No Javadoc found_
82358235

82368236

82378237
|===
8238-
== TLS Registry
8238+
== TLS registry - SPI
82398239
[.configuration-reference,cols=2*]
82408240
|===
82418241
h|Class Name
@@ -8244,10 +8244,10 @@ h|Attributes
82448244

82458245

82468246

8247-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/deployment/src/main/java/io/quarkus/tls/TlsCertificateBuildItem.java[`io.quarkus.tls.TlsCertificateBuildItem`, window="_blank"]
8247+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/deployment-spi/src/main/java/io/quarkus/tls/deployment/spi/TlsCertificateBuildItem.java[`io.quarkus.tls.deployment.spi.TlsCertificateBuildItem`, window="_blank"]
82488248
[.description]
82498249
--
8250-
A build item to register a TLS certificate.
8250+
A build item to register a TLS certificate. An extension can produce an instance of this build item to add a custom certificate into the registry.
82518251
-- a|`java.lang.String name`
82528252
82538253
_No Javadoc found_
@@ -8259,10 +8259,11 @@ _No Javadoc found_
82598259

82608260

82618261

8262-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/deployment/src/main/java/io/quarkus/tls/TlsRegistryBuildItem.java[`io.quarkus.tls.TlsRegistryBuildItem`, window="_blank"]
8262+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/deployment-spi/src/main/java/io/quarkus/tls/deployment/spi/TlsRegistryBuildItem.java[`io.quarkus.tls.deployment.spi.TlsRegistryBuildItem`, window="_blank"]
82638263
[.description]
82648264
--
8265-
A build item that indicates that the TLS registry has been initialized.
8265+
A build item that indicates that the TLS registry has been initialized.
8266+
Do not produce this build item elsewhere than in the TLS registry deployment processor.
82668267
-- a|`java.util.function.Supplier<TlsConfigurationRegistry> registry`
82678268
82688269
_No Javadoc found_

_versions/main/guides/grpc-generation-reference.adoc

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -199,34 +199,28 @@ To do this, define the following properties in the `<properties>` section:
199199

200200
These properties configure the gRPC version and the `protoc` version.
201201

202-
Then, add the `eu.maveniverse.maven.nisse:plugin3` and the `protobuf-maven-plugin` configuration to the `build` section:
202+
Then, add the `os-maven-plugin` extension and the `protobuf-maven-plugin` configuration to the `build` section:
203203

204204
[source,xml]
205205
----
206206
<build>
207+
<extensions>
208+
<extension>
209+
<groupId>kr.motd.maven</groupId>
210+
<artifactId>os-maven-plugin</artifactId>
211+
<version>${os-maven-plugin-version}</version>
212+
</extension>
213+
</extensions>
214+
207215
<plugins>
208-
<plugin>
209-
<groupId>eu.maveniverse.maven.nisse</groupId>
210-
<artifactId>plugin3</artifactId>
211-
<version>0.3.4</version>
212-
<executions>
213-
<execution>
214-
<id>inject-properties</id>
215-
<goals>
216-
<goal>inject-properties</goal>
217-
</goals>
218-
<phase>validate</phase>
219-
</execution>
220-
</executions>
221-
</plugin>
222216
<plugin>
223217
<groupId>org.xolstice.maven.plugins</groupId>
224218
<artifactId>protobuf-maven-plugin</artifactId> <!--1-->
225219
<version>${protobuf-maven-plugin-version}</version>
226220
<configuration>
227-
<protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${nisse.os.classifier}</protocArtifact> <!--2-->
221+
<protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}</protocArtifact> <!--2-->
228222
<pluginId>grpc-java</pluginId>
229-
<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${nisse.os.classifier}</pluginArtifact>
223+
<pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
230224
<protocPlugins>
231225
<protocPlugin>
232226
<id>quarkus-grpc-protoc-plugin</id>
@@ -261,7 +255,7 @@ Then, add the `eu.maveniverse.maven.nisse:plugin3` and the `protobuf-maven-plugi
261255
----
262256

263257
<1> The `protobuf-maven-plugin` generates stub classes from your gRPC service definition (`proto` files).
264-
<2> Class generation uses the tool `protoc`, which is OS-specific. This is why we use the Nisse Maven plugin to target the executable compatible with the operating system.
258+
<2> Class generation uses the tool `protoc`, which is OS-specific. This is why we use the `os-maven-plugin` to target the executable compatible with the operating system.
265259

266260
Note: This configuration instructs the `protobuf-maven-plugin` to generate default gRPC classes and classes using Mutiny to fit with the Quarkus development experience.
267261

_versions/main/guides/jreleaser.adoc

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -107,30 +107,22 @@ shell completion scripts, man pages, license, readme, and more.
107107
== Creating the distribution
108108

109109
We can leverage the link:http://maven.apache.org/plugins/maven-assembly-plugin/[maven-assembly-plugin] to create such
110-
a distribution. We'll also make use of the link:https://github.com/maveniverse/nisse[Nisse Maven plugin] to properly
110+
a distribution. We'll also make use of the link:https://github.com/trustin/os-maven-plugin[os-maven-plugin] to properly
111111
identify the platform on which this executable can run, adding said platform to the distribution's filename.
112112

113-
First, let's add the Nisse Maven plugin to the `pom.xml`. This plugin works as a Maven extension and as such must be added
113+
First, let's add the os-maven-plugin to the `pom.xml`. This plugin works as a Maven extension and as such must be added
114114
to the `<build>` section of the file:
115115

116116
[source,xml]
117117
----
118118
<build>
119-
<plugins>
120-
<plugin>
121-
<groupId>eu.maveniverse.maven.plugins</groupId>
122-
<artifactId>nisse-plugin3</artifactId>
123-
<version>0.3.4</version>
124-
<executions>
125-
<execution>
126-
<id>inject-properties</id>
127-
<goals>
128-
<goal>inject-properties</goal>
129-
</goals>
130-
<phase>validate</phase>
131-
</execution>
132-
</executions>
133-
</plugin>
119+
<extensions>
120+
<extension>
121+
<groupId>kr.motd.maven</groupId>
122+
<artifactId>os-maven-plugin</artifactId>
123+
<version>1.7.1</version>
124+
</extension>
125+
</extensions>
134126
<!-- ... -->
135127
----
136128

@@ -147,7 +139,7 @@ their own directory to avoid cluttering the `target` directory. Thus, let's add
147139

148140
Now we configure the maven-assembly-plugin to create a Zip and a Tar file containing the executable and any supporting files
149141
it may need to perform its job. Take special note on the name of the distribution, this is where we make use of the platform
150-
properties detected by the os-detector-maven-plugin. This plugin is configured in its own profile with the `single` goal bound to
142+
properties detected by the os-maven-plugin. This plugin is configured in its own profile with the `single` goal bound to
151143
the `package` phase. It's done this way to avoid rebuilding the distribution every single time the build is invoked, as we
152144
only needed when we're ready for a release.
153145

@@ -164,7 +156,7 @@ only needed when we're ready for a release.
164156
<configuration>
165157
<attach>false</attach>
166158
<appendAssemblyId>false</appendAssemblyId>
167-
<finalName>${project.artifactId}-${project.version}-${nisse.os.classifier}</finalName>
159+
<finalName>${project.artifactId}-${project.version}-${os.detected.classifier}</finalName>
168160
<outputDirectory>${distribution.directory}</outputDirectory>
169161
<workDirectory>${project.build.directory}/assembly/work</workDirectory>
170162
<descriptors>
@@ -665,21 +657,14 @@ As a reference, these are the full contents of the `pom.xml`:
665657
</dependency>
666658
</dependencies>
667659
<build>
660+
<extensions>
661+
<extension>
662+
<groupId>kr.motd.maven</groupId>
663+
<artifactId>os-maven-plugin</artifactId>
664+
<version>1.7.1</version>
665+
</extension>
666+
</extensions>
668667
<plugins>
669-
<plugin>
670-
<groupId>eu.maveniverse.maven.nisse</groupId>
671-
<artifactId>plugin3</artifactId>
672-
<version>0.3.4</version>
673-
<executions>
674-
<execution>
675-
<id>inject-properties</id>
676-
<goals>
677-
<goal>inject-properties</goal>
678-
</goals>
679-
<phase>validate</phase>
680-
</execution>
681-
</executions>
682-
</plugin>
683668
<plugin>
684669
<groupId>${quarkus.platform.group-id}</groupId>
685670
<artifactId>quarkus-maven-plugin</artifactId>
@@ -738,7 +723,7 @@ As a reference, these are the full contents of the `pom.xml`:
738723
<configuration>
739724
<attach>false</attach>
740725
<appendAssemblyId>false</appendAssemblyId>
741-
<finalName>${project.artifactId}-${project.version}-${nisse.os.classifier}</finalName>
726+
<finalName>${project.artifactId}-${project.version}-${os.detected.classifier}</finalName>
742727
<outputDirectory>${distribution.directory}</outputDirectory>
743728
<workDirectory>${project.build.directory}/assembly/work</workDirectory>
744729
<descriptors>

_versions/main/guides/security-testing.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,10 @@ Additionally, you can specify attributes for the identity, perhaps custom items
101101
SecurityIdentity identity;
102102
103103
@Test
104-
@TestSecurity(user = "testUser", "roles = {"admin, "user"}, attributes = {
105-
@SecurityAttribute(key = "answer", value = "42", type = AttributeType.LONG) }
104+
@TestSecurity(
105+
user = "testUser",
106+
roles = {"admin", "user"},
107+
attributes = { @SecurityAttribute(key = "answer", value = "42", type = AttributeType.LONG) })
106108
void someTestMethod() {
107109
Long answer = identity.<Long>getAttribute("answer");
108110
...

0 commit comments

Comments
 (0)