Merge pull request #23 from BGMSound/develop

BGMSound · web-flow · commit 4f27ec92efb4 · 2025-07-03T21:33:28.000+09:00
[Refactor] Extract vannitech dependency and add test cases
diff --git a/.github/workflows/deploy-to-mavencentral.yaml b/.github/workflows/deploy-to-mavencentral.yaml
@@ -37,8 +37,6 @@ jobs:
           export GPG_TTY=$(tty)
           echo "gpg.secret=$GPG_SECRET" >> gradle.properties
           echo "gpg.passphrase=$GPG_PASSPHRASE" >> gradle.properties
-          echo "mavenCentralUsername=$MAVEN_CENTRAL_USERNAME" >> gradle.properties
-          echo "mavenCentralPassword=$MAVEN_CENTRAL_PASSWORD" >> gradle.properties
           ./gradlew --stacktrace documentify-project:documentify-core:publish
           ./gradlew --stacktrace documentify-project:documentify-gradle-plugin:publish
           ./gradlew --stacktrace documentify-project:documentify-mvc:publish
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -26,6 +26,10 @@ val publicModulePathSet = setOf(
     rootProject.projects.documentifyStarters.documentifyStarterReactive.identityPath.path
 )
 
+repositories {
+    mavenCentral()
+}
+
 subprojects {
     group = rootProject.group
     version = rootProject.version
@@ -51,6 +55,7 @@ subprojects {
             useJUnitPlatform()
         }
     }
+
     if (publicModulePathSet.contains(project.path)) {
         with(pluginManager) {
             apply(rootProject.libs.plugins.gradle.mavenCentral.publish.get().pluginId)
@@ -64,63 +69,78 @@ subprojects {
             useInMemoryPgpKeys(gpgSecret, gpgPassphrase)
             sign(publishing.publications)
         }
-        configure<MavenPublishBaseExtension> {
-            publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)
-
-            val artifactId = name.replace("-gradle-plugin", ".gradle.plugin")
-            val projectGroup = property("project.group").toString()
-            val projectName = property("project.name").toString()
-            val projectVersion = property("project.version.id").toString()
-            val projectDescription = property("project.description").toString()
-            val projectUrl = property("project.url").toString()
-            val projectUrlScm = property("project.url.scm").toString()
-            val projectLicense = property("project.license").toString()
-            val projectLicenseUrl = property("project.license.url").toString()
-            val projectDeveloperId = property("project.developer.id").toString()
-            val projectDeveloperName = property("project.developer.name").toString()
-            val projectDeveloperEmail = property("project.developer.email").toString()
-            val projectDeveloperUrl = property("project.developer.url").toString()
-
-            coordinates(
-                groupId = projectGroup,
-                artifactId = artifactId,
-                version = projectVersion
-            )
-
-            pom {
-                name = projectName
-                description = projectDescription
-                inceptionYear = "${Year.now().value}"
-                url = projectUrl
-                licenses {
-                    license {
-                        name = projectLicense
-                        url = projectLicenseUrl
-                        distribution = projectUrl
+        tasks.withType<Jar> {
+            archiveClassifier.set("")
+        }
+        tasks.withType(PublishToMavenRepository::class.java) {
+            dependsOn(tasks.withType<Sign>())
+        }
+        extensions.getByType<JavaPluginExtension>().apply {
+            withSourcesJar()
+            withJavadocJar()
+        }
+        publishing {
+            repositories {
+                maven {
+                    name = "sonatype"
+                    url = uri("https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/")
+                    credentials {
+                        username = System.getenv("MAVEN_CENTRAL_USERNAME")
+                        password = System.getenv("MAVEN_CENTRAL_PASSWORD")
                     }
                 }
-                developers {
-                    developer {
-                        id = projectDeveloperId
-                        name = projectDeveloperName
-                        email = projectDeveloperEmail
-                        url = projectDeveloperUrl
+            }
+            publications {
+                create<MavenPublication>("mavenCentral") {
+                    from(components["java"])
+                    groupId = property("project.group").toString()
+                    artifactId = name.replace("-gradle-plugin", ".gradle.plugin")
+                    version = property("project.version.id").toString()
+
+                    pom {
+                        val projectName = property("project.name").toString()
+                        val projectDescription = property("project.description").toString()
+                        val projectUrl = property("project.url").toString()
+                        val projectUrlScm = property("project.url.scm").toString()
+                        val projectLicense = property("project.license").toString()
+                        val projectLicenseUrl = property("project.license.url").toString()
+                        val projectDeveloperId = property("project.developer.id").toString()
+                        val projectDeveloperName = property("project.developer.name").toString()
+                        val projectDeveloperEmail = property("project.developer.email").toString()
+                        val projectDeveloperUrl = property("project.developer.url").toString()
+
+                        name = projectName
+                        description = projectDescription
+                        inceptionYear = "${Year.now().value}"
+                        url = projectUrl
+                        licenses {
+                            license {
+                                name = projectLicense
+                                url = projectLicenseUrl
+                                distribution = projectUrl
+                            }
+                        }
+                        developers {
+                            developer {
+                                id = projectDeveloperId
+                                name = projectDeveloperName
+                                email = projectDeveloperEmail
+                                url = projectDeveloperUrl
+                            }
+                        }
+                        scm {
+                            url = projectUrlScm
+                            connection = "scm:git:git://github.com/${projectDeveloperId}"
+                            developerConnection = "scm:git:ssh://git@github.com/${projectDeveloperId}"
+                        }
                     }
-                }
-                scm {
-                    url = projectUrlScm
-                    connection = "scm:git:git://github.com/${projectDeveloperId}"
-                    developerConnection = "scm:git:ssh://git@github.com/${projectDeveloperId}"
+                    signing.sign(this@publications)
                 }
             }
         }
     }
 }
 
-repositories {
-    mavenCentral()
-}
-
 kover {
     merge {
         projects(
diff --git a/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/header/Header.kt
@@ -6,7 +6,7 @@ import org.springframework.restdocs.headers.HeaderDocumentation
 import org.springframework.restdocs.snippet.Attributes
 
 class Header(
-    private val descriptor: HeaderDescriptor,
+    private val descriptor: HeaderDescriptor
 ) : SpecElement(descriptor) {
     override val key: String get() = descriptor.name
 
diff --git a/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/PathVariable.kt
@@ -5,7 +5,7 @@ import org.springframework.restdocs.request.RequestDocumentation
 import org.springframework.restdocs.snippet.Attributes
 
 class PathVariable(
-    descriptor: ParameterDescriptor,
+    descriptor: ParameterDescriptor
 ) : Parameter(descriptor) {
     companion object {
         fun newPathVariable(
diff --git a/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/element/parameter/QueryParameter.kt
@@ -5,7 +5,7 @@ import org.springframework.restdocs.request.RequestDocumentation
 import org.springframework.restdocs.snippet.Attributes
 
 class QueryParameter(
-    descriptor: ParameterDescriptor,
+    descriptor: ParameterDescriptor
 ) : Parameter(descriptor) {
     companion object {
         fun newQueryParameter(
diff --git a/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/ResourceSpec.kt b/documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/ResourceSpec.kt
@@ -29,17 +29,17 @@ class ResourceSpec(
     }
 
     fun link(rel: String): Link {
-        val link = Link.Companion.newLink(rel)
+        val link = Link.newLink(rel)
         this.links.add(link)
         return link
     }
 
     fun links(vararg links: String) {
-        this.links.addAll(links.map { Link.Companion.newLink(it) })
+        this.links.addAll(links.map { Link.newLink(it) })
     }
 
     fun links(links: Collection<String>) {
-        this.links.addAll(links.map { Link.Companion.newLink(it) })
+        this.links.addAll(links.map { Link.newLink(it) })
     }
 
     fun tag(tag: String) {
@@ -94,13 +94,13 @@ class ResourceSpec(
         }
         if (request.fields.isNotEmpty()) {
             if (request.schema != null) {
-                resourceBuilder.requestSchema(Schema.Companion.schema(request.schema!!))
+                resourceBuilder.requestSchema(Schema.schema(request.schema!!))
             }
             resourceBuilder.requestFields(buildFields(request.fields))
         }
         if (response.fields.isNotEmpty()) {
             if (response.schema != null) {
-                resourceBuilder.responseSchema(Schema.Companion.schema(response.schema!!))
+                resourceBuilder.responseSchema(Schema.schema(response.schema!!))
             }
             resourceBuilder.responseFields(buildFields(response.fields))
         }
diff --git a/documentify-sample/build.gradle.kts b/documentify-sample/build.gradle.kts
@@ -1,5 +1,5 @@
 plugins {
-    id("io.github.bgmsound.documentify") version "1.2.5" apply false
+    id("io.github.bgmsound.documentify") version "1.3.6" apply false
 }
 
 subprojects {
diff --git a/gradle.properties b/gradle.properties
@@ -1,7 +1,7 @@
 project.name=documentify
 
 project.group=io.github.bgmsound
-project.version.id=1.3.6
+project.version.id=1.3.7
 project.artifact=documentify
 
 project.description=Documentify is a tool to generate API documentation from source code.

Original file line number	Diff line number	Diff line change
`@@ -29,17 +29,17 @@ class ResourceSpec(`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`fun link(rel: String): Link {`
`32`		`- val link = Link.Companion.newLink(rel)`
	`32`	`+ val link = Link.newLink(rel)`
`33`	`33`	`this.links.add(link)`
`34`	`34`	`return link`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`fun links(vararg links: String) {`
`38`		`- this.links.addAll(links.map { Link.Companion.newLink(it) })`
	`38`	`+ this.links.addAll(links.map { Link.newLink(it) })`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`fun links(links: Collection<String>) {`
`42`		`- this.links.addAll(links.map { Link.Companion.newLink(it) })`
	`42`	`+ this.links.addAll(links.map { Link.newLink(it) })`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`fun tag(tag: String) {`
`@@ -94,13 +94,13 @@ class ResourceSpec(`
`94`	`94`	`}`
`95`	`95`	`if (request.fields.isNotEmpty()) {`
`96`	`96`	`if (request.schema != null) {`
`97`		`- resourceBuilder.requestSchema(Schema.Companion.schema(request.schema!!))`
	`97`	`+ resourceBuilder.requestSchema(Schema.schema(request.schema!!))`
`98`	`98`	`}`
`99`	`99`	`resourceBuilder.requestFields(buildFields(request.fields))`
`100`	`100`	`}`
`101`	`101`	`if (response.fields.isNotEmpty()) {`
`102`	`102`	`if (response.schema != null) {`
`103`		`- resourceBuilder.responseSchema(Schema.Companion.schema(response.schema!!))`
	`103`	`+ resourceBuilder.responseSchema(Schema.schema(response.schema!!))`
`104`	`104`	`}`
`105`	`105`	`resourceBuilder.responseFields(buildFields(response.fields))`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`plugins {`
`2`		`- id("io.github.bgmsound.documentify") version "1.2.5" apply false`
	`2`	`+ id("io.github.bgmsound.documentify") version "1.3.6" apply false`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`subprojects {`