Support developers and contributors

metaborg · Jul 26, 2024 · 9b3dde7 · 9b3dde7
1 parent 61653f2
commit 9b3dde7
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 28 deletions.
diff --git a/convention-plugin/src/main/kotlin/org/metaborg/convention/MavenPublishConventionExtension.kt b/convention-plugin/src/main/kotlin/org/metaborg/convention/MavenPublishConventionExtension.kt
@@ -40,7 +40,9 @@ open class MavenPublishConventionExtension @Inject constructor(
         /** The year the project was started. */
         val inceptionYear: Property<String> = objects.property(String::class.java)
         /** The developers of the project. */
-        val developers: ListProperty<Developer> = objects.listProperty(Developer::class.java)
+        val developers: ListProperty<Person> = objects.listProperty(Person::class.java)
+        /** The (main) contributors of the project. */
+        val contributors: ListProperty<Person> = objects.listProperty(Person::class.java)
         /** The source control management system. */
         val scm: Property<SCM> = objects.property(SCM::class.java)
             .convention(SCM.GitHub)
@@ -57,14 +59,14 @@ open class MavenPublishConventionExtension @Inject constructor(
 }
 
 
-/** Specifies a developer. */
-data class Developer(
-    /** The developer's ID or username. */
-    val id: String,
-    /** The developer's full name. */
+/** Specifies a person. */
+data class Person(
+    /** The person's full name. */
     val name: String,
-    /** The developer's email address. */
-    val email: String,
+    /** The person's ID or username. */
+    val id: String? = null,
+    /** The person's email address. */
+    val email: String? = null,
 )
 
 

diff --git a/convention-plugin/src/main/kotlin/org/metaborg/convention/MavenPublishConventionPlugin.kt b/convention-plugin/src/main/kotlin/org/metaborg/convention/MavenPublishConventionPlugin.kt
@@ -47,13 +47,27 @@ class MavenPublishConventionPlugin: Plugin<Project> {
                                     distribution.set("repo")
                                 }
                             }
+                            organization {
+                                name.set("Programming Languages Group, Delft University of Technology")
+                                url.set("https://pl.ewi.tudelft.nl/")
+                            }
                             developers {
                                 metadata.developers.map {
-                                    for (dev in it) {
+                                    for (person in it) {
                                         developer {
-                                            id.set(dev.id)
-                                            name.set(dev.name)
-                                            email.set(dev.email)
+                                            id.set(person.id)
+                                            name.set(person.name)
+                                            email.set(person.email)
+                                        }
+                                    }
+                                }
+                            }
+                            contributors {
+                                metadata.contributors.map {
+                                    for (person in it) {
+                                        contributor {
+                                            name.set(person.name)
+                                            email.set(person.email)
                                         }
                                     }
                                 }

diff --git a/repo.yaml b/repo.yaml
@@ -30,7 +30,6 @@ plugins:
 developers:
   - id: "Virtlink"
     name: "Daniel A. A. Pelsmaeker"
-    email: "[email protected]"
 
 files:
   githubWorkflows:

diff --git a/repoman/build.gradle.kts b/repoman/build.gradle.kts
@@ -1,4 +1,4 @@
-import org.metaborg.convention.Developer
+import org.metaborg.convention.Person
 
 // Workaround for issue: https://youtrack.jetbrains.com/issue/KTIJ-19369
 @Suppress("DSL_SCOPE_VIOLATION")
@@ -53,7 +53,7 @@ mavenPublishConvention {
     metadata {
         inceptionYear.set("2024")
         developers.set(listOf(
-            Developer("Virtlink", "Daniel A. A. Pelsmaeker", "[email protected]"),
+            Person("Virtlink", "Daniel A. A. Pelsmaeker", "[email protected]"),
         ))
     }
 }
diff --git a/repoman/examplemeta.yaml b/repoman/examplemeta.yaml
diff --git a/repoman/src/main/kotlin/org/metaborg/repoman/meta/RepoMetadata.kt b/repoman/src/main/kotlin/org/metaborg/repoman/meta/RepoMetadata.kt
@@ -43,8 +43,10 @@ data class RepoMetadata(
     /** A list of Gradle plugins published by the repo. */
     val plugins: List<GradlePlugin> = emptyList(),
 
-    /** An ordered list of (main) developers that worked on the repo. */
-    val developers: List<Developer> = emptyList(),
+    /** An ordered list of developers that may be contacted about the repo. */
+    val developers: List<Person> = emptyList(),
+    /** An ordered list of (main) contributors that also worked on the repo. */
+    val contributors: List<Person> = emptyList(),
 
     /** The configurations for the generated files. */
     val files: Files = Files(),
@@ -204,15 +206,15 @@ data class GradlePlugin(
     val description: Markdown? = null,
 )
 
-/** A developer. */
+/** A person. */
 @Serializable
-data class Developer(
-    /** The ID of the developer, usually their GitHub nickname. */
-    val id: String,
-    /** The (full) name of the developer. */
+data class Person(
+    /** The ID of the person, usually their GitHub nickname. */
+    val id: String? = null,
+    /** The (full) name of the person. */
     val name: String,
-    /** The e-mail address of the developer. */
-    val email: String,
+    /** The e-mail address of the person. */
+    val email: String? = null,
 )
 
 /** An included build. */

diff --git a/repoman/src/main/resources/templates/build.gradle.kts.kte b/repoman/src/main/resources/templates/build.gradle.kts.kte
@@ -1,7 +1,7 @@
 @import org.metaborg.repoman.meta.Defaults
 @import org.metaborg.repoman.meta.RepoMetadata
 @param meta: RepoMetadata
-import org.metaborg.convention.Developer
+import org.metaborg.convention.Person
 import org.metaborg.convention.MavenPublishConventionExtension
 
 // Workaround for issue: https://youtrack.jetbrains.com/issue/KTIJ-19369
@@ -46,7 +46,14 @@ allprojects {
 @if(meta.developers.isNotEmpty())
                 developers.set(listOf(
     @for(entry in meta.developers)
-                    Developer("${entry.id}", "${entry.name}", "${entry.email}"),
+                    Person("${entry.name}", email = ${if (entry.email != null) "\"${entry.email}\"" else "null"}, id = ${if (entry.id != null) "\"${entry.id}\"" else "null"}),
+    @endfor
+                ))
+@endif
+@if(meta.contributors.isNotEmpty())
+                contributors.set(listOf(
+    @for(entry in meta.contributors)
+                    Person("${entry.name}", email = ${if (entry.email != null) "\"${entry.email}\"" else "null"}, id = ${if (entry.id != null) "\"${entry.id}\"" else "null"}),
     @endfor
                 ))
 @endif