Skip to content

Commit 407c831

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent a10ab95 commit 407c831

File tree

9 files changed

+637
-15
lines changed

9 files changed

+637
-15
lines changed

‎_data/versioned/main/index/quarkus.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1626,6 +1626,17 @@ types:
16261626
- io.quarkus:quarkus-funqy-knative-events
16271627
type: guide
16281628
url: /guides/funqy-knative-events
1629+
- title: Generating CycloneDX BOMs
1630+
filename: cyclonedx.adoc
1631+
summary: This guide explains how to generate SBOMs for Quarkus applications in the CycloneDX format.
1632+
categories: tooling
1633+
topics:
1634+
- sbom
1635+
extensions:
1636+
- io.quarkus:quarkus-cyclonedx
1637+
id: cyclonedx
1638+
type: guide
1639+
url: /guides/cyclonedx
16291640
- title: Generating Jakarta REST resources with Panache
16301641
filename: rest-data-panache.adoc
16311642
summary: Hibernate ORM REST Data with Panache simplifies the creation of CRUD applications based on Jakarta REST and Hibernate ORM.

‎_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8015,6 +8015,79 @@ endif::add-copy-button-to-env-var[]
80158015
|`false`
80168016

80178017

8018+
h|[.extension-name]##CycloneDX##
8019+
h|Type
8020+
h|Default
8021+
8022+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##`quarkus.cyclonedx.skip`##
8023+
8024+
[.description]
8025+
--
8026+
Whether to skip SBOM generation
8027+
8028+
8029+
ifdef::add-copy-button-to-env-var[]
8030+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SKIP+++[]
8031+
endif::add-copy-button-to-env-var[]
8032+
ifndef::add-copy-button-to-env-var[]
8033+
Environment variable: `+++QUARKUS_CYCLONEDX_SKIP+++`
8034+
endif::add-copy-button-to-env-var[]
8035+
--
8036+
|boolean
8037+
|`false`
8038+
8039+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##`quarkus.cyclonedx.format`##
8040+
8041+
[.description]
8042+
--
8043+
SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option.
8044+
8045+
8046+
ifdef::add-copy-button-to-env-var[]
8047+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[]
8048+
endif::add-copy-button-to-env-var[]
8049+
ifndef::add-copy-button-to-env-var[]
8050+
Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++`
8051+
endif::add-copy-button-to-env-var[]
8052+
--
8053+
|string
8054+
|`json`
8055+
8056+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##`quarkus.cyclonedx.schema-version`##
8057+
8058+
[.description]
8059+
--
8060+
CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library.
8061+
8062+
8063+
ifdef::add-copy-button-to-env-var[]
8064+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[]
8065+
endif::add-copy-button-to-env-var[]
8066+
ifndef::add-copy-button-to-env-var[]
8067+
Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++`
8068+
endif::add-copy-button-to-env-var[]
8069+
--
8070+
|string
8071+
|
8072+
8073+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##`quarkus.cyclonedx.include-license-text`##
8074+
8075+
[.description]
8076+
--
8077+
Whether to include the license text into generated SBOMs.
8078+
8079+
8080+
ifdef::add-copy-button-to-env-var[]
8081+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++[]
8082+
endif::add-copy-button-to-env-var[]
8083+
ifndef::add-copy-button-to-env-var[]
8084+
Environment variable: `+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++`
8085+
endif::add-copy-button-to-env-var[]
8086+
--
8087+
|boolean
8088+
|`false`
8089+
8090+
80188091
h|[.extension-name]##Datasources##
80198092
h|Type
80208093
h|Default

‎_generated-doc/main/config/quarkus-cyclonedx.adoc

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
:summaryTableId: quarkus-cyclonedx_quarkus-cyclonedx
2+
[.configuration-legend]
3+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
4+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
5+
|===
6+
7+
h|[.header-title]##Configuration property##
8+
h|Type
9+
h|Default
10+
11+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##`quarkus.cyclonedx.skip`##
12+
13+
[.description]
14+
--
15+
Whether to skip SBOM generation
16+
17+
18+
ifdef::add-copy-button-to-env-var[]
19+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SKIP+++[]
20+
endif::add-copy-button-to-env-var[]
21+
ifndef::add-copy-button-to-env-var[]
22+
Environment variable: `+++QUARKUS_CYCLONEDX_SKIP+++`
23+
endif::add-copy-button-to-env-var[]
24+
--
25+
|boolean
26+
|`false`
27+
28+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##`quarkus.cyclonedx.format`##
29+
30+
[.description]
31+
--
32+
SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option.
33+
34+
35+
ifdef::add-copy-button-to-env-var[]
36+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[]
37+
endif::add-copy-button-to-env-var[]
38+
ifndef::add-copy-button-to-env-var[]
39+
Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++`
40+
endif::add-copy-button-to-env-var[]
41+
--
42+
|string
43+
|`json`
44+
45+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##`quarkus.cyclonedx.schema-version`##
46+
47+
[.description]
48+
--
49+
CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library.
50+
51+
52+
ifdef::add-copy-button-to-env-var[]
53+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[]
54+
endif::add-copy-button-to-env-var[]
55+
ifndef::add-copy-button-to-env-var[]
56+
Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++`
57+
endif::add-copy-button-to-env-var[]
58+
--
59+
|string
60+
|
61+
62+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##`quarkus.cyclonedx.include-license-text`##
63+
64+
[.description]
65+
--
66+
Whether to include the license text into generated SBOMs.
67+
68+
69+
ifdef::add-copy-button-to-env-var[]
70+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++[]
71+
endif::add-copy-button-to-env-var[]
72+
ifndef::add-copy-button-to-env-var[]
73+
Environment variable: `+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++`
74+
endif::add-copy-button-to-env-var[]
75+
--
76+
|boolean
77+
|`false`
78+
79+
|===
80+
81+
82+
:!summaryTableId:

‎_generated-doc/main/config/quarkus-cyclonedx_quarkus.cyclonedx.adoc

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
:summaryTableId: quarkus-cyclonedx_quarkus-cyclonedx
2+
[.configuration-legend]
3+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
4+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
5+
|===
6+
7+
h|[.header-title]##Configuration property##
8+
h|Type
9+
h|Default
10+
11+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##`quarkus.cyclonedx.skip`##
12+
13+
[.description]
14+
--
15+
Whether to skip SBOM generation
16+
17+
18+
ifdef::add-copy-button-to-env-var[]
19+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SKIP+++[]
20+
endif::add-copy-button-to-env-var[]
21+
ifndef::add-copy-button-to-env-var[]
22+
Environment variable: `+++QUARKUS_CYCLONEDX_SKIP+++`
23+
endif::add-copy-button-to-env-var[]
24+
--
25+
|boolean
26+
|`false`
27+
28+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##`quarkus.cyclonedx.format`##
29+
30+
[.description]
31+
--
32+
SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option.
33+
34+
35+
ifdef::add-copy-button-to-env-var[]
36+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[]
37+
endif::add-copy-button-to-env-var[]
38+
ifndef::add-copy-button-to-env-var[]
39+
Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++`
40+
endif::add-copy-button-to-env-var[]
41+
--
42+
|string
43+
|`json`
44+
45+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##`quarkus.cyclonedx.schema-version`##
46+
47+
[.description]
48+
--
49+
CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library.
50+
51+
52+
ifdef::add-copy-button-to-env-var[]
53+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[]
54+
endif::add-copy-button-to-env-var[]
55+
ifndef::add-copy-button-to-env-var[]
56+
Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++`
57+
endif::add-copy-button-to-env-var[]
58+
--
59+
|string
60+
|
61+
62+
a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##`quarkus.cyclonedx.include-license-text`##
63+
64+
[.description]
65+
--
66+
Whether to include the license text into generated SBOMs.
67+
68+
69+
ifdef::add-copy-button-to-env-var[]
70+
Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++[]
71+
endif::add-copy-button-to-env-var[]
72+
ifndef::add-copy-button-to-env-var[]
73+
Environment variable: `+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++`
74+
endif::add-copy-button-to-env-var[]
75+
--
76+
|boolean
77+
|`false`
78+
79+
|===
80+
81+
82+
:!summaryTableId:

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ _No Javadoc found_
118118

119119
_No Javadoc found_
120120

121+
`java.util.function.Supplier<DependencyInfoProvider> depInfoProvider`
122+
123+
_No Javadoc found_
124+
121125

122126

123127

@@ -234,6 +238,10 @@ _No Javadoc found_
234238

235239
_No Javadoc found_
236240

241+
`io.quarkus.sbom.ApplicationManifestConfig manifestConfig`
242+
243+
_No Javadoc found_
244+
237245

238246

239247

@@ -1181,6 +1189,10 @@ _No Javadoc found_
11811189

11821190
_No Javadoc found_
11831191

1192+
`io.quarkus.sbom.ApplicationManifestConfig manifestConfig`
1193+
1194+
_No Javadoc found_
1195+
11841196

11851197

11861198

@@ -2168,6 +2180,17 @@ _No Javadoc found_
21682180

21692181

21702182

2183+
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/sbom/SbomBuildItem.java[`io.quarkus.deployment.sbom.SbomBuildItem`, window="_blank"]
2184+
[.description]
2185+
--
2186+
Aggregates SBOMs generated for packaged applications. The API around this is still in development and will likely change in the near future.
2187+
-- a|`io.quarkus.bootstrap.app.SbomResult result`
2188+
2189+
_No Javadoc found_
2190+
2191+
2192+
2193+
21712194
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/ServiceProviderBuildItem.java[`io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem`, window="_blank"]
21722195
[.description]
21732196
--

0 commit comments

Comments
 (0)