-
Notifications
You must be signed in to change notification settings - Fork 29
/
NexusPublishPlugin.kt
233 lines (220 loc) · 11.6 KB
/
NexusPublishPlugin.kt
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
/*
* Copyright 2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.github.gradlenexus.publishplugin
import io.github.gradlenexus.publishplugin.internal.StagingRepositoryDescriptorRegistry
import io.github.gradlenexus.publishplugin.internal.StagingRepositoryDescriptorRegistryBuildService
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.Task
import org.gradle.api.artifacts.repositories.MavenArtifactRepository
import org.gradle.api.provider.Provider
import org.gradle.api.publish.PublishingExtension
import org.gradle.api.publish.maven.MavenPublication
import org.gradle.api.publish.maven.tasks.PublishToMavenRepository
import org.gradle.api.publish.plugins.PublishingPlugin
import org.gradle.api.tasks.TaskProvider
import org.gradle.kotlin.dsl.create
import org.gradle.kotlin.dsl.invoke
import org.gradle.kotlin.dsl.named
import org.gradle.kotlin.dsl.register
import org.gradle.kotlin.dsl.the
import org.gradle.kotlin.dsl.withType
import org.gradle.util.GradleVersion
@Suppress("UnstableApiUsage")
class NexusPublishPlugin : Plugin<Project> {
companion object {
//visibility for testing
const val SIMPLIFIED_CLOSE_AND_RELEASE_TASK_NAME = "closeAndReleaseStagingRepository"
}
override fun apply(project: Project) {
require(project == project.rootProject) {
"Plugin must be applied to the root project but was applied to ${project.path}"
}
val registry = createRegistry(project)
val extension = project.extensions.create<NexusPublishExtension>(NexusPublishExtension.NAME, project)
configureNexusTasks(project, extension, registry)
configurePublishingForAllProjects(project, extension, registry)
}
private fun createRegistry(rootProject: Project): Provider<StagingRepositoryDescriptorRegistry> {
if (GradleVersion.current() >= GradleVersion.version("6.1")) {
return rootProject.gradle.sharedServices
.registerIfAbsent("stagingRepositoryUrlRegistry", StagingRepositoryDescriptorRegistryBuildService::class.java) {}
.map { it.registry }
}
val registry = StagingRepositoryDescriptorRegistry()
return rootProject.provider { registry }
}
private fun configureNexusTasks(rootProject: Project, extension: NexusPublishExtension, registry: Provider<StagingRepositoryDescriptorRegistry>) {
extension.repositories.all {
val repository = this
val retrieveStagingProfileTask = rootProject.tasks.register<RetrieveStagingProfile>("retrieve${capitalizedName}StagingProfile", rootProject.objects, extension, repository)
val initializeTask = rootProject.tasks.register<InitializeNexusStagingRepository>(
"initialize${capitalizedName}StagingRepository", rootProject.objects, extension, repository, registry
)
val closeTask = rootProject.tasks.register<CloseNexusStagingRepository>(
"close${capitalizedName}StagingRepository", rootProject.objects, extension, repository, registry
)
val releaseTask = rootProject.tasks.register<ReleaseNexusStagingRepository>(
"release${capitalizedName}StagingRepository", rootProject.objects, extension, repository, registry
)
val closeAndReleaseTask = rootProject.tasks.register<Task>(
"closeAndRelease${capitalizedName}StagingRepository"
)
retrieveStagingProfileTask {
description = "Gets and displays a staging profile id for a given repository and package group. This is a diagnostic task to get the value and put it into the NexusRepository configuration closure as stagingProfileId."
}
closeTask {
description = "Closes open staging repository in '${repository.name}' Nexus instance."
group = PublishingPlugin.PUBLISH_TASK_GROUP
mustRunAfter(initializeTask)
}
releaseTask {
description = "Releases closed staging repository in '${repository.name}' Nexus instance."
group = PublishingPlugin.PUBLISH_TASK_GROUP
mustRunAfter(initializeTask)
mustRunAfter(closeTask)
}
closeAndReleaseTask {
description = "Closes and releases open staging repository in '${repository.name}' Nexus instance."
group = PublishingPlugin.PUBLISH_TASK_GROUP
dependsOn(closeTask, releaseTask)
}
}
extension.repositories.whenObjectRemoved {
rootProject.tasks.named("initialize${capitalizedName}StagingRepository").configure {
enabled = false
}
rootProject.tasks.named("close${capitalizedName}StagingRepository").configure {
enabled = false
}
rootProject.tasks.named("release${capitalizedName}StagingRepository").configure {
enabled = false
}
rootProject.tasks.named("closeAndRelease${capitalizedName}StagingRepository").configure {
enabled = false
}
}
rootProject.tasks.register<Task>(SIMPLIFIED_CLOSE_AND_RELEASE_TASK_NAME) {
description = "Closes and releases open staging repositories in all configured Nexus instances."
group = PublishingPlugin.PUBLISH_TASK_GROUP
enabled = false
}
}
private fun configurePublishingForAllProjects(rootProject: Project, extension: NexusPublishExtension, registry: Provider<StagingRepositoryDescriptorRegistry>) {
rootProject.afterEvaluate {
allprojects {
val publishingProject = this
plugins.withId("maven-publish") {
val nexusRepositories = addMavenRepositories(publishingProject, extension, registry)
nexusRepositories.forEach { (nexusRepo, mavenRepo) ->
val initializeTask = rootProject.tasks.named<InitializeNexusStagingRepository>("initialize${nexusRepo.capitalizedName}StagingRepository")
val closeTask = rootProject.tasks.named<CloseNexusStagingRepository>("close${nexusRepo.capitalizedName}StagingRepository")
val releaseTask = rootProject.tasks.named<ReleaseNexusStagingRepository>("release${nexusRepo.capitalizedName}StagingRepository")
val publishAllTask = publishingProject.tasks.register("publishTo${nexusRepo.capitalizedName}") {
description = "Publishes all Maven publications produced by this project to the '${nexusRepo.name}' Nexus repository."
group = PublishingPlugin.PUBLISH_TASK_GROUP
}
closeTask {
mustRunAfter(publishAllTask)
}
releaseTask {
mustRunAfter(publishAllTask)
}
configureTaskDependencies(publishingProject, initializeTask, publishAllTask, closeTask, releaseTask, mavenRepo)
}
}
}
configureSimplifiedCloseAndReleaseTask(rootProject, extension)
}
}
private fun addMavenRepositories(project: Project, extension: NexusPublishExtension, registry: Provider<StagingRepositoryDescriptorRegistry>): Map<NexusRepository, MavenArtifactRepository> {
return extension.repositories.associateWith { nexusRepo ->
project.the<PublishingExtension>().repositories.maven {
name = nexusRepo.name
setUrl(
project.provider {
getRepoUrl(nexusRepo, extension, registry)
}
)
val allowInsecureProtocol = nexusRepo.allowInsecureProtocol.orNull
if (allowInsecureProtocol != null) {
if (GradleVersion.current() >= GradleVersion.version("6.0")) {
isAllowInsecureProtocol = allowInsecureProtocol
} else {
project.logger.warn("Configuration of allowInsecureProtocol=$allowInsecureProtocol will be ignored because it requires Gradle 6.0 or later")
}
}
credentials {
username = nexusRepo.username.orNull
password = nexusRepo.password.orNull
}
}
}
}
private fun configureTaskDependencies(
project: Project,
initializeTask: TaskProvider<InitializeNexusStagingRepository>,
publishAllTask: TaskProvider<Task>,
closeTask: TaskProvider<CloseNexusStagingRepository>,
releaseTask: TaskProvider<ReleaseNexusStagingRepository>,
mavenRepo: MavenArtifactRepository
) {
val mavenPublications = project.the<PublishingExtension>().publications.withType<MavenPublication>()
mavenPublications.configureEach {
val publication = this
val publishTask = project.tasks.named<PublishToMavenRepository>(
"publish${publication.name.capitalize()}PublicationTo${mavenRepo.name.capitalize()}Repository"
)
publishTask {
dependsOn(initializeTask)
doFirst { logger.info("Uploading to {}", repository.url) }
}
publishAllTask {
dependsOn(publishTask)
}
closeTask {
mustRunAfter(publishTask)
}
releaseTask {
mustRunAfter(publishTask)
}
}
}
private fun getRepoUrl(nexusRepo: NexusRepository, extension: NexusPublishExtension, registry: Provider<StagingRepositoryDescriptorRegistry>) =
if (extension.useStaging.get()) {
registry.get()[nexusRepo.name].stagingRepositoryUrl
} else {
nexusRepo.snapshotRepositoryUrl.get()
}
private fun configureSimplifiedCloseAndReleaseTask(rootProject: Project, extension: NexusPublishExtension) {
if (extension.repositories.isNotEmpty()) {
val closeAndReleaseSimplifiedTask = rootProject.tasks.named(SIMPLIFIED_CLOSE_AND_RELEASE_TASK_NAME)
closeAndReleaseSimplifiedTask.configure {
val repositoryNamesAsString = extension.repositories.joinToString(", ") { "'${it.name}'" }
val instanceCardinalityAwareString = if (extension.repositories.size > 1) { "instances" } else { "instance" }
description = "Closes and releases open staging repositories in the following Nexus $instanceCardinalityAwareString: $repositoryNamesAsString"
enabled = true
}
extension.repositories.all {
val repositoryCapitalizedName = this.capitalizedName
val closeAndReleaseTask = rootProject.tasks.named<Task>("closeAndRelease${repositoryCapitalizedName}StagingRepository")
closeAndReleaseSimplifiedTask.configure {
dependsOn(closeAndReleaseTask)
}
}
}
}
}