自从多年前 JCenter 关闭服务之后,GSY 项目版本就一直发布在 Jitpack 上,如今每个月也都有大概 10w+ 左右下载,但是近年来时不时就会出现历史版本丢失的问题,而且有时候还不是某个具体版本丢失,而是版本里的某几个依赖突然 404 了,例如 #6645 / #5973 问题所示,所以在找不到原因的情况,只能寻找多一个版本托管的平台做 backup。
在对比了 MavenCenter 和 Github Packages 之后,感觉还是 Github Packages 更加符合我这个懒人的要求,首先不需要注册新平台帐号,体系还在 Github 内,通过 Github Action 就可以实现自动构建,之后根据 tag 将 aar 包发布到 Github Packages ,整体来说还是比较轻量。
昨天评论区有人说介绍下这个流程,所以这里就简单梳理一下,其实并不复杂。
开始
使用 Github Action 我记得以前也介绍过,相对来说也挺简单,只需要在自己 Github 的开源项目下创建 .github/workflows
目录,然后编写脚本就可以完成接入,另外针对 Github Actions 官方还提供了 marketplace 用于开发者提交或者引用别人写好的 aciton ,所以很多时候开发者在使用 Github Actions 时,其实会变成了在 marketplace 里挑选和组合 action 的场景。
以下是 GSY 项目在 .github/workflows/release.yml
下的 action 配置,这里简单介绍一下:
- on push tags :表示在提交任意 tag 时触发 action 执行,你也可以自己定制规则
- jobs 下有两个任务,一个是 release 用于构建一个 demo apk,一个是 publish 用于发布 Github Packages
- release 下:
runs-on: ubuntu-latest
指定运行环境- 使用
actions/checkout@v3
切换到指定 tag - 使用
actions/setup-java@v3
指定 jdk 版本 - 使用
gradle/gradle-build-action@v2
指定 gradle 环境并执行命令app:assembleRelease
- 使用
ncipollo/release-action@v1
将编译好的 apk 发布到 github release
- publish 下:
- 给予同样逻辑,不同之处在于通过 gradle 环境,直接执行
./gradlew publish
将 library aar 发布到 github packags 的 mvn
- 给予同样逻辑,不同之处在于通过 gradle 环境,直接执行
name: Release
on:
push:
tags:
- '*'
jobs:
release:
name: Github Release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 21
- name: Build APK
uses: gradle/gradle-build-action@v2
with:
arguments: app:assembleRelease
- name: Create Release
uses: ncipollo/release-action@v1
with:
artifacts: "app/build/outputs/apk/release/app-release.apk"
token: ${{ secrets.GITHUB_TOKEN }}
publish:
name: Publish To Github Packages
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: 'zulu'
java-version: 21
- uses: gradle/gradle-build-action@v2
- name: Publish Package
run: ./gradlew publish
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
上述的
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
是通过 github 通用 ci 的automatic-token-authentication
实现 ,在每个 workflow job 执行时,GitHub 会自动创建一个唯一的GITHUB_TOKEN
密钥在 workflow 中进行身份验证,Token 的权限仅限于包含workflow 的仓库。
可以看到一套下下来,基本不需要你写什么 action 脚本,之后就是在每个需要发布的 library 的 build.gralde
添加脚本 ,例如这里 https://maven.pkg.github.com/
是固定前缀,用户是 CarGuo
,repo 名为 GSYVideoPlayer
的 publishing 配置,而 credentials
只需要在 action 运行时读取系统变量配置即可:
apply plugin: "maven-publish"
publishing {
repositories {
maven {
name = "gsyvideoplayer"
url = "https://maven.pkg.github.com/CarGuo/GSYVideoPlayer"
credentials {
username = System.getenv("GITHUB_ACTOR")
password = System.getenv("GITHUB_TOKEN")
}
}
}
}
剩下的就是发布 mvn 的常规配置,这部分应该无需多言了,简单举个例子,例如写一个通用的 publish.gradle
读取 gradle.properties
配置,然后将这个 publish.gradle
apply 到上面的 build.gralde
脚本里:
apply plugin: "maven-publish"
android {
publishing {
singleVariant('release') {
withSourcesJar()
withJavadocJar()
}
}
}
afterEvaluate {
publishing {
publications {
release(MavenPublication) {
from components.release
group = PROJ_GROUP
artifactId = PROJ_ARTIFACTID
version = PROJ_VERSION
pom {
name = PROJ_NAME
description = PROJ_DESCRIPTION
url = PROJ_VCSURL
licenses {
license {
name = "The Apache License, Version 2.0"
url = "https://www.apache.org/licenses/LICENSE-2.0.txt"
}
}
developers {
developer {
id = DEVELOPER_ID
name = DEVELOPER_NAME
}
}
scm {
connection = PROJ_ISSUETRACKERURL
developerConnection = PROJ_VCSURL
url = PROJ_WEBSITEURL
}
}
}
}
}
}
以下就是对应上述 publish.gradle
的根目录下的 gradle.properties
配置,核心就是前面四个参数,简单来说就是 com.shuyu:gsyvideoplayer:10.0.0
这样的对应
PROJ_GROUP=com.shuyu
PROJ_VERSION=10.0.0
PROJ_NAME=gsyvideoplayer
PROJ_ARTIFACTID=gsyvideoplayer
PROJ_WEBSITEURL=https://github.com/CarGuo/GSYVideoPlayer
PROJ_ISSUETRACKERURL=https://github.com/CarGuo/GSYVideoPlayer/issues
PROJ_VCSURL=https://github.com/CarGuo/GSYVideoPlayer.git
PROJ_DESCRIPTION=android video player
PROJ_USER_MAVEN=GSYVideoPlayer
DEVELOPER_ID=guo
DEVELOPER_NAME=guoshuyu
DEVELOPER_EMAIL=xxxxxx@.com
如果一个 project 有多个 module 需要发布定义,可以在每个 moudle 的
gradle.properties
配置单独配置PROJ_NAME
和PROJ_ARTIFACTID
变量
在此之后只需要在 git 提交时提交某个 tag ,github 就会自动触发 action 执行,然后构建 aar 包并发布到 github packages 。
当然,这里有一个很让人菊紧的问题,那就是 PROJ_NAME
和 PROJ_ARTIFACTID
必须是小写,别问我为什么,我也不知道,stackoverflow 上大家都这么说,如果有大写,会出现如图 Received status code 422 from server: Unprocessable Entity 这样的错误,改成全小写才成功通过:
成功发布后,就可以在你的 Packages 上看到提交的包了,之后就可以开始引用,不过 github packags 引用 mvn 也有一个让人菊紧的问题。
引用 github mvn ,主要是需要在你的 allprojects{ repositories {
下增加 https://maven.pkg.github.com
的引用,如下代码所示,这里主要是需要 credentials
授权,是的,github packages 上就算你的 mvn 包是 public 的,它也需要你授权,而且目前 github 的口径是,不考虑不授权支持,而授权主要是通过生成一个用户 token 来完成。
maven {
url 'https://maven.pkg.github.com/CarGuo/GSYVideoPlayer'
credentials {
username = '你的github账户'
password = '你的生成 token'
}
}
生成 token 理论上就是在 Github 右上角点击头像,然后 Settings - Developer Settings - Personal access tokens - tokens (classic) - Generate new token(classic
即可生成,这里需要注意:
- 记得过期时间选择永久
- 如果只是为了 mvn,就选一个
read:packages
即可
详细生成自己 token 的方式可见:docs.github.com/zh/authenti…
到这里基本完成了 github ci 发布 mvn 和引用的工作了,其实抛开 gradle mvn 配置部分,其实整个流程还是简单的,首先 github 账号和 github 项目本来就存在的,只需要配置下 action 和 gradle 指向 github pkg 即可完成发布,之后只需要在每次需要发布时提交 tag 即可实现自动发布,除了引用麻烦一些,其实整体都还不错。