-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
net.twisterrob.gradle.build.publish.gradle.kts
241 lines (225 loc) · 7.94 KB
/
net.twisterrob.gradle.build.publish.gradle.kts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
import net.twisterrob.gradle.build.dsl.base
import net.twisterrob.gradle.build.dsl.gradlePlugin
import net.twisterrob.gradle.build.dsl.java
import net.twisterrob.gradle.build.dsl.publishing
import net.twisterrob.gradle.build.publishing.GradlePluginValidationPlugin
import net.twisterrob.gradle.build.publishing.getChild
import net.twisterrob.gradle.build.publishing.withDokkaJar
import org.jetbrains.dokka.gradle.DokkaTask
import java.time.Instant
import java.time.format.DateTimeFormatter
plugins {
id("org.gradle.maven-publish")
id("org.gradle.signing")
id("org.jetbrains.dokka")
}
plugins.apply(GradlePluginValidationPlugin::class)
group = project.property("projectGroup").toString()
version = project.property("projectVersion").toString()
plugins.withId("org.gradle.java") {
afterEvaluate {
// Delayed configuration, so that project.* is set up properly in corresponding modules' build.gradle.kts.
tasks.named<Jar>("jar") {
manifest {
attributes(
mapOf(
// Implementation-* used by TestPlugin
"Implementation-Vendor" to project.group,
"Implementation-Title" to project.base.archivesName.get(),
"Implementation-Version" to project.version,
"Built-Date" to DateTimeFormatter.ISO_INSTANT.format(Instant.now()),
)
)
}
}
}
}
normalization {
runtimeClasspath {
metaInf {
ignoreAttribute("Built-Date")
}
}
}
/**
* @see org.jetbrains.dokka.gradle.DokkaPlugin
*/
@Suppress("PropertyName", "VariableNaming")
val DOKKA_TASK_NAME: String = "dokkaJavadoc"
// Note: org.gradle.api.publish.plugins.PublishingPlugin.apply calls publications.all,
// so most code here is eagerly executed, even inside register { }!
project.java.withDokkaJar(project, project.tasks.named(DOKKA_TASK_NAME))
project.java.withSourcesJar()
setupDoc(project)
setupSigning(project)
project.plugins.withId("net.twisterrob.gradle.build.module.library") {
project.publishing.apply {
publications {
register<MavenPublication>("library") {
setupModuleIdentity(project)
setupPublication(project)
// compiled files: artifact(tasks["jar"])) { classifier = null } + dependencies
from(project.components["java"])
}
}
}
}
project.plugins.withId("net.twisterrob.gradle.build.module.gradle-plugin") {
registerPublicationsTasks(project)
project.gradlePlugin.apply {
@Suppress("UnstableApiUsage")
website = "https://github.com/TWiStErRob/net.twisterrob.gradle"
@Suppress("UnstableApiUsage")
vcsUrl = "https://github.com/TWiStErRob/net.twisterrob.gradle.git"
}
project.publishing.publications.apply {
// Pre-configure pluginMaven for MavenPluginPublishPlugin, it'll set up other things.
create<MavenPublication>("pluginMaven") {
setupModuleIdentity(project)
setupPublication(project)
handleTestFixtures()
}
withType<MavenPublication>()
.matching { it.name.endsWith("PluginMarkerMaven") }
.configureEach {
setupPublication(project)
}
}
}
fun MavenPublication.setupPublication(project: Project) {
project.configure<SigningExtension> {
sign(this@setupPublication)
}
setupLinks(project)
reorderNodes(project)
}
@Suppress("UnusedReceiverParameter")
fun MavenPublication.handleTestFixtures() {
// Disable publication of test fixtures as it could leak internal dependencies.
val java = components["java"] as AdhocComponentWithVariants
java.withVariantsFromConfiguration(configurations.getByName("testFixturesApiElements")) { skip() }
java.withVariantsFromConfiguration(configurations.getByName("testFixturesRuntimeElements")) { skip() }
// Not suppressing warnings, because they should be skipped, if they show up, that's a problem.
//suppressPomMetadataWarningsFor("testFixturesApiElements")
//suppressPomMetadataWarningsFor("testFixturesRuntimeElements")
}
fun setupDoc(project: Project) {
project.tasks.named<DokkaTask>(DOKKA_TASK_NAME) {
// TODO https://github.com/Kotlin/dokka/issues/1894
moduleName = this.project.base.archivesName
dokkaSourceSets.configureEach {
reportUndocumented = false
}
}
}
fun setupSigning(project: Project) {
project.configure<SigningExtension> {
//val signingKeyId: String? by project // Gradle 6+ only
// -PsigningKey to gradlew, or ORG_GRADLE_PROJECT_signingKey env var
val signingKey: String? by project
// -PsigningPassword to gradlew, or ORG_GRADLE_PROJECT_signingPassword env var
val signingPassword: String? by project
if (signingKey != null && signingPassword != null) {
useInMemoryPgpKeys(signingKey, signingPassword)
} else {
setRequired { false }
}
}
}
fun MavenPublication.setupModuleIdentity(project: Project) {
// Delayed configuration, so that project.* is set up properly in corresponding modules' build.gradle.kts.
project.afterEvaluate {
artifactId = project.base.archivesName.get()
version = project.version as String
pom {
val projectDescription = project.description?.takeIf { it.contains(": ") && it.endsWith(".") }
?: error(
"${project} must have a description with format: \"Module Display Name: Module description.\""
+ ", found ${project.description}"
)
name = projectDescription.substringBefore(": ").also { check(it.isNotBlank()) }
description = projectDescription.substringAfter(": ").also { check(it.isNotBlank()) }
}
}
}
fun MavenPublication.setupLinks(project: Project) {
pom {
url = "https://github.com/TWiStErRob/net.twisterrob.gradle"
scm {
connection = "scm:git:github.com/TWiStErRob/net.twisterrob.gradle.git"
developerConnection = "scm:git:ssh://github.com/TWiStErRob/net.twisterrob.gradle.git"
url = "https://github.com/TWiStErRob/net.twisterrob.gradle/tree/main"
}
licenses {
license {
name = "Unlicense"
url = "https://github.com/TWiStErRob/net.twisterrob.gradle/blob/v${project.version}/LICENCE"
}
}
developers {
developer {
id = "TWiStErRob"
name = "Robert Papp"
email = "papp.robert.s@gmail.com"
}
}
}
}
fun MavenPublication.reorderNodes(project: Project) {
project.afterEvaluate {
pom.withXml {
asNode().apply {
val lastNodes = listOf(
getChild("modelVersion"),
getChild("groupId"),
getChild("artifactId"),
getChild("version"),
getChild("name"),
getChild("description"),
getChild("url"),
getChild("dependencies"),
getChild("scm"),
getChild("developers"),
getChild("licenses")
)
lastNodes.forEach { remove(it) }
lastNodes.forEach { append(it) }
}
}
}
}
/**
* Create convenience lifecycle tasks for markers.
*
* @see org.gradle.plugin.devel.plugins.MavenPluginPublishPlugin.createMavenMarkerPublication
* @see org.gradle.api.publish.maven.plugins.MavenPublishPlugin.createPublishTasksForEachMavenRepo
*/
fun registerPublicationsTasks(project: Project) {
val markersFragment = "AllPluginMarkerMavenPublications"
val markersDescription = "all Gradle Plugin Marker publications"
val markerPublications = project.the<PublishingExtension>()
.publications
.matching {
it is MavenPublication && it.name.endsWith("PluginMarkerMaven")
}
project.tasks.register("publish${markersFragment}ToMavenLocal") task@{
group = PublishingPlugin.PUBLISH_TASK_GROUP
description = "Publishes ${markersDescription} produced by this project to the local Maven cache."
markerPublications.all publication@{
val publication = this@publication.name
this@task.dependsOn("publish${publication.replaceFirstChar(Char::uppercase)}PublicationToMavenLocal")
}
}
project.the<PublishingExtension>().repositories.all repository@{
val repository = this@repository.name
val repositoryFragment = repository.replaceFirstChar(Char::uppercase)
project.tasks.register("publish${markersFragment}To${repositoryFragment}Repository") task@{
group = PublishingPlugin.PUBLISH_TASK_GROUP
description = "Publishes ${markersDescription} produced by this project to the ${repository} repository."
markerPublications.all publication@{
val publicationFragment = this@publication.name.replaceFirstChar(Char::uppercase)
this@task.dependsOn("publish${publicationFragment}PublicationTo${repositoryFragment}Repository")
}
}
}
}