创建存储签名文件的私有仓库#

首先，我们在github上创建一个私有仓库，为简单起见，我们将其称为 keystore。得到的仓库地址是git@github.com:Ernest-su/keystore.git

然后，把仓库clone到本地。git clone git@github.com:Ernest-su/keystore.git

将签名文件放到keystore内.例如，我的签名文件名称是keyfile

1
git add .\keyfile
2
git commit -m "添加签名文件"
3
git push origin main

注意: 在github上新建仓库的时候，github已经把默认分支从以前的master改为了main ,所以上面的命令是git push origin main，而不是之前的git push origin master

添加签名文件仓库为git的子模块#

切换到项目目录，使用以下命令将包含密钥文件的私有存储库添加为子模块，为简单起见，我们将其称为 keystore。

git submodule add git@github.com:Ernest-su/keystore.git keystore

这样，我们便拥有了可以在本地进行签名的密钥库，并且因为该仓库是私有仓库，其他人不会获取到签名文件。

可以看到，项目已经多了一个keystore文件夹，里面有我们的签名文件。因为是作为git的子模块submodule 来添加的，所以提交的时候，项目只会引用子模块的提交信息，不会包含此文件夹。

加密的环境变量 Secrets#

为了拥有更安全的环境来使用github actions签署apk,我们在项目的设置中做以下配置。

在项目 Settings -> Secrets-> Actions 中配置加密的环境变量，这里配置的环境变量很安全，有特殊处理，不会在日志中显示。同时也不会传递由 Fork 发起的 Pull Request。

以下配置，KEY*开头的是签名文件的密码和签名别名，根据上面添加为git子模块的签名文件填入正确的信息。

TOKEN配置的是github 的 PAT,也就是Personal access tokens，这里就不展开介绍了，可以查阅官方的说明 这里配置的TOKEN用于Github Actions执行时，拉取私有仓库子模块的签名文件。

修改app签名配置#

在app模块的build.gradle中调整签名配置。System.getenv读取的是系统环境变量，在GitHub Actions执行时候，读取的是上面加密的环境变量 Secrets 中配置的信息。

1
    signingConfigs {
2
        release {
3

4
            storeFile file(KEYSTORE)
5

6
            storePassword System.getenv("KEYSTORE_PASSWORD")
7

8
            keyAlias System.getenv("KEY_ALIAS")
9

10
            keyPassword System.getenv("KEY_PASSWORD")
11
        }
12
    }

在项目根目录的gradle.properties配置以下信息。我们把KEYSTORE直接在这里定义了，而不是通过获取系统环境变量的方式。当然，通过上面定义加密的环境变量Secrets,再用读取系统环境变量的方式，也是ok的。

1
KEYSTORE=../keystore/keyfile
2
#以下配置到环境变量里了,在github actions的脚本中会自动读取
3
# KEY_ALIAS=System.getenv("KEY_ALIAS")
4
# KEY_PASSWORD=[your key password]
5
# KEYSTORE_PASSWORD=[your store password]

Github Actions 触发条件#

简单说明下配置的含义。

1
on:
2
  push:
3
    tags:
4
      - '*'

意思是在推送tag到远程仓库时候，触发GitHub Actions。'*' 表示推送所有的tag都会触发，可以改为'v*',表示推送了v开头的tag才触发。如果希望是在推送到特定分支时候触发，如release，则可以这样配置

1
on:
2
  push:
3
    branches: [ release ]

或需要推送到master分支时候触发

1
on:
2
  push:
3
    branches: [ master ]

但是需要注意,如果master分支是默认分支，且是私有仓库，会浪费掉GitHub Actions的运行时间额度。公共仓库和自托管运行器免费使用 GitHub Actions。 对于私有仓库，每个 GitHub 帐户可获得一定数量的免费记录和存储。关于额度的说明

Github Actions 的子模块配置#

1
- uses: actions/checkout@v3
2
  with:
3
   submodules: recursive
4
   token: ${{ secrets.TOKEN }}

只有加了 submodules: recursive以及 token: ${{ secrets.TOKEN }}才会在构建时候拉取到私有仓库的子模块。

读取Actions 加密系统环境变量#

1
- name: Build with Gradle
2
  env: #  as an environment variable
3
    KEYSTORE_PASSWORD: ${{ secrets.KEYSTORE_PASSWORD }}
4
    KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
5
    KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}

此步骤用于配置解密后的环境变量到系统环境变量中,供gradle脚本使用

上传apk文件到github release#

1
- name: Upload binaries to release
2
  uses: svenstaro/upload-release-action@v2
3
  with:
4
    repo_token: ${{ secrets.GITHUB_TOKEN }}
5
    file:  app/build/outputs/apk/release/*.apk
6
    tag: ${{ github.ref }}
7
    release_name: ${{ github.ref }}
8
    overwrite: true
9
    file_glob: true
10
    body: ""