如何将README.md同步至GitHub Package Registry的Java包描述？

可以通过配置Gradle的maven-publish插件，读取本地README.md内容并写入Maven POM文件，让GitHub Package Registry自动抓取该内容作为包描述，无需手动填写。以下是具体实现方式：

Groovy DSL（build.gradle）配置示例 #

plugins {
    id 'java'
    id 'maven-publish'
}

publishing {
    publications {
        mavenJava(MavenPublication) {
            // 关联Java组件产物
            from components.java
            
            pom {
                // 基础包信息
                name = '你的包名称'
                // 读取README.md内容作为包描述
                description = file('README.md').text
                url = '你的GitHub仓库地址'
                
                // 可选：配置开发者信息
                developers {
                    developer {
                        id = '你的GitHub ID'
                        name = '你的姓名'
                        email = '你的联系邮箱'
                    }
                }
                
                // 可选：配置源码仓库信息
                scm {
                    connection = 'scm:git:git://github.com/你的用户名/仓库名.git'
                    developerConnection = 'scm:git:ssh://github.com/你的用户名/仓库名.git'
                    url = '你的GitHub仓库地址'
                }
            }
        }
    }
    
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/你的用户名/仓库名")
            // 通过环境变量获取GitHub凭证（避免硬编码）
            credentials {
                username = System.getenv("GITHUB_ACTOR")
                password = System.getenv("GITHUB_TOKEN")
            }
        }
    }
}

Kotlin DSL（build.gradle.kts）配置示例 #

plugins {
    java
    `maven-publish`
}

publishing {
    publications {
        create<MavenPublication>("mavenJava") {
            from(components["java"])
            
            pom {
                name.set("你的包名称")
                description.set(file("README.md").readText())
                url.set("你的GitHub仓库地址")
                
                developers {
                    developer {
                        id.set("你的GitHub ID")
                        name.set("你的姓名")
                        email.set("你的联系邮箱")
                    }
                }
                
                scm {
                    connection.set("scm:git:git://github.com/你的用户名/仓库名.git")
                    developerConnection.set("scm:git:ssh://github.com/你的用户名/仓库名.git")
                    url.set("你的GitHub仓库地址")
                }
            }
        }
    }
    
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/你的用户名/仓库名")
            credentials {
                username = System.getenv("GITHUB_ACTOR")
                password = System.getenv("GITHUB_TOKEN")
            }
        }
    }
}

关键注意事项 #

• 路径匹配：如果你的README.md不在执行gradlew的./java目录下（比如在项目根目录），需要调整文件路径为file('../README.md')，确保Gradle能正确读取文件。
• 凭证权限：GITHUB_TOKEN需要拥有packages:write和repo权限，否则会导致发布失败或信息同步不完整。
• 无需修改文件名：保持README.md的默认文件名即可，不需要额外重命名。

配置完成后，重新执行./java/gradlew publish，GitHub Package Registry会自动解析POM文件中的description字段，将README内容同步为包的描述信息。

内容的提问来源于stack exchange，提问作者Gurgen Yegoryan