Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

automatically close the created repository and optionally also release it #403

Merged
merged 1 commit into from Sep 4, 2022
Merged

automatically close the created repository and optionally also release it #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 23 additions & 19 deletions nexus/src/main/kotlin/com/vanniktech/maven/publish/nexus/Nexus.kt
View file
Open in desktop
Expand Up @@ -135,9 +135,18 @@ class Nexus(
return repository
}

private fun closeStagingRepository(stagingRepository: Repository): String {
private fun closeStagingRepository(stagingRepository: Repository) {
val repositoryId = stagingRepository.repositoryId

if (stagingRepository.type == "closed") {
if (stagingRepository.transitioning) {
waitForClose(stagingRepository.repositoryId)
} else {
println("Repository $repositoryId already closed")
}
return
}

if (stagingRepository.type != "open") {
throw IllegalArgumentException("Repository $repositoryId is of type '${stagingRepository.type}' and not 'open'")
}
Expand All @@ -149,8 +158,7 @@ class Nexus(
}

waitForClose(repositoryId)

return repositoryId
println("Repository $repositoryId closed")
}

private fun waitForClose(repositoryId: String) {
Expand Down Expand Up @@ -190,7 +198,18 @@ class Nexus(
}
}

private fun releaseStagingRepository(repositoryId: String) {
fun closeCurrentStagingRepository(): String {
val stagingRepository = findStagingRepository()
closeStagingRepository(stagingRepository)
return stagingRepository.repositoryId
}

fun closeStagingRepository(repositoryId: String) {
val stagingRepository = getStagingRepository(repositoryId)
closeStagingRepository(stagingRepository)
}

fun releaseStagingRepository(repositoryId: String) {
println("Releasing repository: $repositoryId")
val response = service.releaseRepository(
TransitionRepositoryInput(
Expand All @@ -208,21 +227,6 @@ class Nexus(
println("Repository $repositoryId released")
}

private fun closeAndReleaseRepository(stagingRepository: Repository) {
closeStagingRepository(stagingRepository)
releaseStagingRepository(stagingRepository.repositoryId)
}

fun closeAndReleaseCurrentRepository() {
val stagingRepository = findStagingRepository()
closeAndReleaseRepository(stagingRepository)
}

fun closeAndReleaseRepositoryById(repositoryId: String) {
val stagingRepository = getStagingRepository(repositoryId)
closeAndReleaseRepository(stagingRepository)
}

companion object {
private const val PROGRESS_1 = "\u2839"
private const val PROGRESS_2 = "\u2838"
Expand Down
18 changes: 14 additions & 4 deletions plugin/src/main/kotlin/com/vanniktech/maven/publish/MavenPublishBaseExtension.kt
View file
Open in desktop
Expand Up @@ -11,6 +11,8 @@ import org.gradle.api.credentials.PasswordCredentials
import org.gradle.api.provider.Property
import org.gradle.api.publish.maven.MavenPom
import org.gradle.api.publish.maven.MavenPublication
import org.gradle.build.event.BuildEventsListenerRegistry
import org.gradle.configurationcache.extensions.serviceOf
import org.gradle.plugins.signing.SigningPlugin

@Incubating
Expand All @@ -25,18 +27,24 @@ abstract class MavenPublishBaseExtension(

/**
* Sets up Maven Central publishing through Sonatype OSSRH by configuring the target repository. Gradle will then
* automatically create a `publishAllPublicationsToMavenRepository` task as well as include it in the general
* `publish` task. If the current version ends with `-SNAPSHOT` the artifacts will be published to Sonatype's snapshot
* automatically create a `publishAllPublicationsToMavenCentralRepository` task as well as include it in the general
* `publish` task. As part of running publish the plugin will automatically create a staging repostory on Sonatype
* to which all artifacts will be published. At the end of the build this staging repository will be automatically
* closed. When the [automaticRelease] parameter is `true` the staging repository will also be released
* automatically afterwards.
* If the current version ends with `-SNAPSHOT` the artifacts will be published to Sonatype's snapshot
* repository instead.
*
* This expects you provide your Sonatype user name and password through Gradle properties called
* This expects you provide your Sonatype username and password through Gradle properties called
* `mavenCentralUsername` and `mavenCentralPassword`.
*
* The `closeAndReleaseRepository` task is automatically configured for Sonatype OSSRH using the same credentials.
*
* @param host the instance of Sonatype OSSRH to use
* @param automaticRelease whether a non SNAPSHOT build should be released automatically at the end of the build
*/
fun publishToMavenCentral(host: SonatypeHost = SonatypeHost.DEFAULT) {
@JvmOverloads
fun publishToMavenCentral(host: SonatypeHost = SonatypeHost.DEFAULT, automaticRelease: Boolean = false) {
sonatypeHost.set(host)
sonatypeHost.finalizeValue()

Expand All @@ -46,7 +54,9 @@ abstract class MavenPublishBaseExtension(
sonatypeHost = sonatypeHost,
repositoryUsername = project.providers.gradleProperty("mavenCentralUsername"),
repositoryPassword = project.providers.gradleProperty("mavenCentralPassword"),
automaticRelease = automaticRelease,
)
project.serviceOf<BuildEventsListenerRegistry>().onTaskCompletion(buildService)

val groupId = project.provider { project.group.toString() }
val versionIsSnapshot = project.provider { project.versionIsSnapshot }
Expand Down
5 changes: 3 additions & 2 deletions plugin/src/main/kotlin/com/vanniktech/maven/publish/MavenPublishPlugin.kt
View file
Open in desktop
Expand Up @@ -18,8 +18,9 @@ open class MavenPublishPlugin : Plugin<Project> {
project.setCoordinates()

val sonatypeHost = project.findOptionalProperty("SONATYPE_HOST")
if (sonatypeHost != null && sonatypeHost.isNotBlank()) {
baseExtension.publishToMavenCentral(SonatypeHost.valueOf(sonatypeHost))
if (!sonatypeHost.isNullOrBlank()) {
val automaticRelease = project.findOptionalProperty("SONATYPE_AUTOMATIC_RELEASE").toBoolean()
baseExtension.publishToMavenCentral(SonatypeHost.valueOf(sonatypeHost), automaticRelease)
}
val releaseSigning = project.findOptionalProperty("RELEASE_SIGNING_ENABLED")?.toBoolean()
if (releaseSigning == true) {
Expand Down
6 changes: 4 additions & 2 deletions ...ain/kotlin/com/vanniktech/maven/publish/sonatype/CloseAndReleaseSonatypeRepositoryTask.kt
View file
Open in desktop
Expand Up @@ -32,9 +32,11 @@ internal abstract class CloseAndReleaseSonatypeRepositoryTask : DefaultTask() {

val manualStagingRepositoryId = this.manualStagingRepositoryId
if (manualStagingRepositoryId != null) {
service.nexus.closeAndReleaseRepositoryById(manualStagingRepositoryId)
service.nexus.closeStagingRepository(manualStagingRepositoryId)
service.nexus.releaseStagingRepository(manualStagingRepositoryId)
} else {
service.nexus.closeAndReleaseCurrentRepository()
val id = service.nexus.closeCurrentStagingRepository()
service.nexus.releaseStagingRepository(id)
}

service.repositoryClosed = true
Expand Down
30 changes: 29 additions & 1 deletion ...n/src/main/kotlin/com/vanniktech/maven/publish/sonatype/SonatypeRepositoryBuildService.kt
View file
Open in desktop
Expand Up @@ -7,12 +7,16 @@ import org.gradle.api.provider.Provider
import org.gradle.api.services.BuildService
import org.gradle.api.services.BuildServiceParameters
import org.gradle.api.services.BuildServiceRegistry
import org.gradle.tooling.events.FinishEvent
import org.gradle.tooling.events.OperationCompletionListener
import org.gradle.tooling.events.task.TaskFailureResult

internal abstract class SonatypeRepositoryBuildService : BuildService<SonatypeRepositoryBuildService.Params> {
internal abstract class SonatypeRepositoryBuildService : BuildService<SonatypeRepositoryBuildService.Params>, AutoCloseable, OperationCompletionListener {
internal interface Params : BuildServiceParameters {
val sonatypeHost: Property<SonatypeHost>
val repositoryUsername: Property<String>
val repositoryPassword: Property<String>
val automaticRelease: Property<Boolean>
}

val nexus = Nexus(
Expand All @@ -36,19 +40,43 @@ internal abstract class SonatypeRepositoryBuildService : BuildService<SonatypeRe
// indicates whether we already closed a staging repository to avoid doing it more than once in a build
var repositoryClosed: Boolean = false

var buildHasFailure: Boolean = false

override fun onFinish(event: FinishEvent) {
if (event.result is TaskFailureResult) {
buildHasFailure = true
}
}

override fun close() {
if (buildHasFailure) {
return
}

val stagingRepositoryId = this.stagingRepositoryId
if (stagingRepositoryId != null) {
nexus.closeStagingRepository(stagingRepositoryId)
if (parameters.automaticRelease.get()) {
nexus.releaseStagingRepository(stagingRepositoryId)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this a change from what we had before when executing closeAndReleaseRepository. With 0.21.0 it always does close and release. And now when upgrading to this version it only does close. Why don't we auto release by default?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how it compares:

Running publish:
0.21.0: implictly createst staging repo, uploads
now - flag off (default): creates staging repo, uploads, closes it
now - flag on: creates staging repo, uploads, closes it, releases it

Running closeAndReleaseRepository when repo is open
0.21.0: finds repo, if there is just one closes and releases it
now: finds repo, if there is just one closes and releases it

Running closeAndReleaseRepository when repo is closed
0.21.0: finds repo, fails
now: finds repo, if there is just one releases it

So closeAndReleaseRepository generally behaves like before and if you had publish and closeAndReleaseRepository running on ci (or you were manually executing them) the end result is the same. The automatic release flag gives you the option to let publish also release it so that you don't need to run closeAndReleaseRepository at all. I thought making the automatic release opt in is a bit safer as it's not something you can reverse.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aaah okay. Now i understand it, thanks!

}
}
}

companion object {
private const val NAME = "sonatype-repository-build-service"

fun BuildServiceRegistry.registerSonatypeRepositoryBuildService(
sonatypeHost: Provider<SonatypeHost>,
repositoryUsername: Provider<String>,
repositoryPassword: Provider<String>,
automaticRelease: Boolean,
): Provider<SonatypeRepositoryBuildService> {
return registerIfAbsent(NAME, SonatypeRepositoryBuildService::class.java) {
it.maxParallelUsages.set(1)
it.parameters.sonatypeHost.set(sonatypeHost)
it.parameters.repositoryUsername.set(repositoryUsername)
it.parameters.repositoryPassword.set(repositoryPassword)
it.parameters.automaticRelease.set(automaticRelease)
}
}
}
Expand Down