Skip to content

Commit 535286b

Browse files
aalmirayaalmiray
committed
1 parent 701c9ce commit 535286b

File tree

8 files changed

+203
-102
lines changed

8 files changed

+203
-102
lines changed

‎docs/antora.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ asciidoc:
88
jreleaser-tag: early-access
99
jreleaser-raw-ghcontent: https://raw.githubusercontent.com/jreleaser/jreleaser/main
1010
jreleaser-extension-api: 'https://raw.githubusercontent.com/jreleaser/jreleaser/main/api/jreleaser-model-api/src/main/java/org/jreleaser/extensions/api'
11-
pomchecker-version: 1.13.0
12-
cyclonedx-version: 0.25.0
13-
syft-version: 1.2.0
11+
pomchecker-version: 1.14.0
12+
cyclonedx-version: 0.27.1
13+
syft-version: 1.12.2
1414
jib-version: 0.12.0
1515
icons: font
1616
icon_req_y: icon:check[role="green"]

‎docs/modules/reference/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
** xref:checksum.adoc[]
3838
** xref:deploy/index.adoc[]
3939
*** xref:deploy/maven/index.adoc[]
40+
**** xref:deploy/maven/pomchecker.adoc[]
4041
**** xref:deploy/maven/artifactory.adoc[]
4142
**** xref:deploy/maven/azure.adoc[]
4243
**** xref:deploy/maven/gitea.adoc[]

‎docs/modules/reference/pages/deploy/maven/pomchecker.adoc‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
= PomChecker
2+
3+
Validates if a POM complies with the rules for deploying to Maven Central using link:https://kordamp.org/pomchecker/[PomChecker].
4+
5+
== Configuration
6+
7+
include::partial$legend.adoc[]
8+
9+
[tabs]
10+
====
11+
YAML::
12+
+
13+
--
14+
[source,yaml]
15+
[subs="+macros,attributes"]
16+
----
17+
# icon:dot-circle[]
18+
deploy:
19+
maven:
20+
# icon:dot-circle[]
21+
pomchecker:
22+
# Defines the tool version to use.
23+
# icon:dot-circle[]
24+
version: {pomchecker-version}
25+
26+
# Fail the release if PomChecker outputs a warning.
27+
# Defaults to `true`.
28+
# icon:dot-circle[]
29+
failOnWarning: false
30+
31+
# Fail the release if PomChecker outputs an error.
32+
# Defaults to `true`.
33+
# icon:dot-circle[]
34+
failOnError: false
35+
36+
# Enables or disables strict mode.
37+
# Defaults to `true`.
38+
# icon:dot-circle[]
39+
strict: false
40+
----
41+
--
42+
TOML::
43+
+
44+
--
45+
[source,toml]
46+
[subs="+macros,attributes"]
47+
----
48+
[deploy.maven]
49+
# Defines the tool version to use.
50+
# icon:dot-circle[]
51+
pomchecker.version = "{pomchecker-version}"
52+
53+
# Fail the release if PomChecker outputs a warning.
54+
# Defaults to `true`.
55+
# icon:dot-circle[]
56+
pomchecker.failOnWarning = false
57+
58+
# Fail the release if PomChecker outputs an error.
59+
# Defaults to `true`.
60+
# icon:dot-circle[]
61+
pomchecker.failOnError = false
62+
63+
# Enables or disables strict mode.
64+
# Defaults to `true`.
65+
# icon:dot-circle[]
66+
pomchecker.strict = false
67+
----
68+
--
69+
JSON::
70+
+
71+
--
72+
[source,json]
73+
[subs="+macros,attributes"]
74+
----
75+
{
76+
// icon:dot-circle[]
77+
"deploy": {
78+
"maven": {
79+
// icon:dot-circle[]
80+
"pomchecker": {
81+
// Defines the tool version to use.
82+
// icon:dot-circle[]
83+
"version": "{pomchecker-version}",
84+
85+
// Fail the release if PomChecker outputs a warning.
86+
// Defaults to `true`.
87+
// icon:dot-circle[]
88+
"failOnWarning": false,
89+
90+
// Fail the release if PomChecker outputs an error.
91+
// Defaults to `true`.
92+
// icon:dot-circle[]
93+
"failOnError": false,
94+
95+
// Enables or disables strict mode.
96+
// Defaults to `true`.
97+
// icon:dot-circle[]
98+
"strict": false
99+
}
100+
}
101+
}
102+
}
103+
----
104+
--
105+
Maven::
106+
+
107+
--
108+
[source,xml]
109+
[subs="+macros,attributes,verbatim"]
110+
----
111+
<jreleaser>
112+
<!--
113+
icon:dot-circle[]
114+
-->
115+
<deploy>
116+
<maven>
117+
<!--
118+
icon:dot-circle[]
119+
-->
120+
<pomchecker>
121+
<!--
122+
Defines the tool version to use.
123+
icon:dot-circle[]
124+
-->
125+
<version>{pomchecker-version}</version>
126+
127+
<!--
128+
Fail the release if PomChecker outputs a warning.
129+
Defaults to `true`.
130+
icon:dot-circle[]
131+
-->
132+
<failOnWarning>false</failOnWarning>
133+
134+
<!--
135+
Fail the release if PomChecker outputs an error.
136+
Defaults to `true`.
137+
icon:dot-circle[]
138+
-->
139+
<failOnError>false</failOnError>
140+
141+
<!--
142+
Enables or disables strict mode.
143+
Defaults to `true`.
144+
icon:dot-circle[]
145+
-->
146+
<strict>false</strict>
147+
</pomchecker>
148+
</maven>
149+
</deploy>
150+
</jreleaser>
151+
----
152+
--
153+
Gradle::
154+
+
155+
--
156+
[source,groovy]
157+
[subs="+macros,attributes"]
158+
----
159+
jreleaser {
160+
// icon:dot-circle[]
161+
deploy {
162+
maven {
163+
// icon:dot-circle[]
164+
pomchecker {
165+
// Defines the tool version to use.
166+
// icon:dot-circle[]
167+
version = '{pomchecker-version}'
168+
169+
// Fail the release if PomChecker outputs a warning.
170+
// Defaults to `true`.
171+
// icon:dot-circle[]
172+
failOnWarning = false
173+
174+
// Fail the release if PomChecker outputs an error.
175+
// Defaults to `true`.
176+
// icon:dot-circle[]
177+
failOnError = false
178+
179+
// Enables or disables strict mode.
180+
// Defaults to `true`.
181+
// icon:dot-circle[]
182+
strict = false
183+
}
184+
}
185+
}
186+
}
187+
----
188+
--
189+
====

‎docs/modules/reference/partials/deploy/maven/gradle/common-head.adoc‎

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,6 @@ jreleaser {
22
// icon:dot-circle[]
33
deploy {
44
maven {
5-
// icon:dot-circle[]
6-
pomchecker {
7-
// Defines the tool version to use.
8-
// icon:dot-circle[]
9-
version = '{pomchecker-version}'
10-
11-
// Fail the release if pomchecker outputs a warning.
12-
// Defaults to `true`.
13-
// icon:dot-circle[]
14-
failOnWarning = false
15-
16-
// Fail the release if pomchecker outputs an error.
17-
// Defaults to `true`.
18-
// icon:dot-circle[]
19-
failOnError = false
20-
}
21-
225
// icon:dot-circle[]
236
{deployer_id} {
247
// Deployers require a name.
@@ -78,7 +61,7 @@ jreleaser {
7861
javadocJar = false
7962

8063
// Verifies that POM files comply with the minimum requirements for publication
81-
// to Maven Central. Checks rules using link:https://kordamp.org/pomchecker/[PomChecker].
64+
// to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
8265
// Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
8366
// icon:dot-circle[]
8467
verifyPom = false
@@ -114,7 +97,7 @@ jreleaser {
11497
javadocJar = false
11598

11699
// Verifies that POM files comply with the minimum requirements for publication
117-
// to Maven Central. Checks rules using link:https://kordamp.org/pomchecker/[PomChecker].
100+
// to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
118101
// icon:dot-circle[]
119102
verifyPom = false
120103
}

‎docs/modules/reference/partials/deploy/maven/json/common-head.adoc‎

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,6 @@
22
// icon:dot-circle[]
33
"deploy": {
44
"maven": {
5-
// icon:dot-circle[]
6-
"pomchecker": {
7-
// Defines the tool version to use.
8-
// icon:dot-circle[]
9-
"version": "{pomchecker-version}",
10-
11-
// Fail the release if pomchecker outputs a warning.
12-
// Defaults to `true`.
13-
// icon:dot-circle[]
14-
"failOnWarning": false,
15-
16-
// Fail the release if pomchecker outputs an error.
17-
// Defaults to `true`.
18-
// icon:dot-circle[]
19-
"failOnError": false
20-
},
21-
225
// icon:dot-circle[]
236
"{deployer_id}": {
247
// Deployers require a name.
@@ -78,7 +61,7 @@
7861
"javadocJar": false,
7962

8063
// Verifies that POM files comply with the minimum requirements for publication
81-
// to Maven Central. Checks rules using link:https://kordamp.org/pomchecker/[PomChecker].
64+
// to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
8265
// Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
8366
// icon:dot-circle[]
8467
"verifyPom": false,
@@ -115,7 +98,7 @@
11598
"javadocJar": false,
11699

117100
// Verifies that POM files comply with the minimum requirements for publication
118-
// to Maven Central. Checks rules using link:https://kordamp.org/pomchecker/[PomChecker].
101+
// to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
119102
// icon:dot-circle[]
120103
"verifyPom": false
121104
}

‎docs/modules/reference/partials/deploy/maven/maven/common-head.adoc‎

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,6 @@
44
-->
55
<deploy>
66
<maven>
7-
<!--
8-
icon:dot-circle[]
9-
-->
10-
<pomchecker>
11-
<!--
12-
Defines the tool version to use.
13-
icon:dot-circle[]
14-
-->
15-
<version>{pomchecker-version}</version>
16-
17-
<!--
18-
Fail the release if pomchecker outputs a warning.
19-
Defaults to `true`.
20-
icon:dot-circle[]
21-
-->
22-
<failOnWarning>false</failOnWarning>
23-
24-
<!--
25-
Fail the release if pomchecker outputs an error.
26-
Defaults to `true`.
27-
icon:dot-circle[]
28-
-->
29-
<failOnError>false</failOnError>
30-
</pomchecker>
317
<!--
328
icon:dot-circle[]
339
-->
@@ -111,7 +87,7 @@
11187

11288
<!--
11389
Verifies that POM files comply with the minimum requirements for publication
114-
to Maven Central. Checks rules using link:https//kordamp.org/pomchecker/[PomChecker].
90+
to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
11591
Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
11692
icon:dot-circle[]
11793
-->
@@ -164,7 +140,7 @@
164140

165141
<!--
166142
Verifies that POM files comply with the minimum requirements for publication
167-
to Maven Central. Checks rules using link:https//kordamp.org/pomchecker/[PomChecker].
143+
to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
168144
icon:dot-circle[]
169145
-->
170146
<verifyPom>false</verifyPom>

‎docs/modules/reference/partials/deploy/maven/toml/common-head.adoc‎

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
[deploy.maven]
2-
# Defines the tool version to use.
3-
# icon:dot-circle[]
4-
pomchecker.version = "{pomchecker-version}"
5-
6-
# Fail the release if pomchecker outputs a warning.
7-
# Defaults to `true`.
8-
# icon:dot-circle[]
9-
pomchecker.failOnWarning = false
10-
11-
# Fail the release if pomchecker outputs an error.
12-
# Defaults to `true`.
13-
# icon:dot-circle[]
14-
pomchecker.failOnError = false
15-
161
# Deployers require a name.
172
# icon:exclamation-triangle[]
183
[deploy.maven.{deployer_id}.app]
@@ -70,7 +55,7 @@
7055
javadocJar = false
7156

7257
# Verifies that POM files comply with the minimum requirements for publication
73-
# to Maven Central. Checks rules using link:https://kordamp.org/pomchecker/[PomChecker].
58+
# to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
7459
# Defaults to `false` unless `applyMavenCentralRules` is set to `true`.
7560
# icon:dot-circle[]
7661
verifyPom = false
@@ -107,7 +92,7 @@
10792
javadocJar = false
10893

10994
# Verifies that POM files comply with the minimum requirements for publication
110-
# to Maven Central. Checks rules using link:https://kordamp.org/pomchecker/[PomChecker].
95+
# to Maven Central. Checks rules using xref:deploy/maven/pomchecker.adoc[PomChecker].
11196
# icon:dot-circle[]
11297
verifyPom = false
11398

0 commit comments

Comments
 (0)