上周接了个需求,需要把项目中一个模块打包发布到git上供其他项目使用。
大无语,查了一大堆真的是醉醉的,乱七八糟没有一个好使的,最后还是官方文档靠谱啊,xdm,以后有需求先查官方文档啊!!!
我个人认为,写博客不光是为了记录,同时最好也能帮别人解决一些问题,只有这样一篇博客才多少有点价值吧,写到哪种程度呢,最好是饭都送到嘴边那种程度!!!这样自己回过头来看的时候,也不会一脸懵。
下面想详细说一下gradle发布依赖包到github仓库的具体步骤。
请保证访问github畅通,最好网络好一点,因为上传和下载如果网络不佳,是很可能失败的。
第一步:修改配置
(此处是单个包,多个包参考官网,区别不大,官网地址文末会放)在你需要发布的模块的build.gradle文件中,添加下列代码:
plugins {
id 'maven-publish'
}
publishing {
repositories {
maven {
name = "GitHubPackages"
url = uri("https://maven.pkg.github.com/jwcxs-m/jarproject")
credentials {
username = System.getenv("GITHUB_ACTOR")
password = System.getenv("GITHUB_TOKEN")
}
}
}
publications {
gpr(MavenPublication) {
from(components.java)
}
}
}
username和password我这里配了环境变量,如果嫌麻烦甚至可以在发包的时候直接给定值,像下面这样:
credentials {
username = "Damon"
password = "ghp_7asdwrc123dsww34YyqkkpP1jHzvR"
}
注意:如果直接填写了token,不要把token直接提交到github仓库中,不然github会检测到你的token被上传到项目里,就强行给你把token停用了!!!
然后就是说password,就是这个token咋生成的:
最后拉到最下方,点这个绿的一键生成。
生成后的token复制出来,因为只有第一次能看到,下次进来就看不到了。然后把token设置给上面的password就行。
第二步:发布
找个喜欢的地方(常用终端或者是IDEA里的终端都行…),直接执行gradle publish
(不出意外的话,就会看到发布成功,出意外了再说…)
乌鱼子,刚说完就报错了…
Failed to publish publication 'gpr' to repository 'GitHubPackages'
Could not PUT 'https://maven.pkg.github.com/jwcxs-m/tjar/io/dingodb/d/0.1.0-SNAPSHOT/d-0.1.0-20220316.024713-3.jar'. Received status code 422 from server: Unprocessable Entity
一开始我以为是项目的问题,就尝试重新在github上新建项目,然后试了有2次都不行。
就换了个思路,结合之前成功的项目,发现现在使用这个项目没有gradle的子模块,就尝试建了一个子模块:
然后就publish成功了:
github仓库中显示:
至此,使用gradle发布依赖包到github已经完全讲完了。
如何使用上传的依赖包
传都传上去了,总不能不说使用的事情吧,那不合理…
上面github截图那个红框点进去会看到:
如果不是很清楚怎么使用,就先看看这个,然后根据这个去在配置里引用该依赖包:
上面那块红框内的东西,跟publish时的配置保持一致就可以了,主要是url一定要一致。
dependencies里,引用依赖格式是groupId:artifactId:version
配置好以后按下面两种方式刷新都可以:
或
刷新之后在左侧也可查看。(如果下载不了,首先查看url以及dependencies到底设置的对不对,然后就是再次强调:网一定要好…不然很难下载下来。)
到此结束吧,可能中途还会碰到一些问题,比如我在下载依赖包的时候,因为网络太差,导致下载失败解析不了,去本地仓库查看,发现目录下全是lastupdated后缀结尾的文件,于是整个目录全删除,网络确定好一点的时候,又重新刷新才下载下来。
官方文档(里面还有maven等各种型号):
https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry