Skip to content

release.md

Latest commit

 

History

History
87 lines (63 loc) · 2.46 KB

release.md

File metadata and controls

87 lines (63 loc) · 2.46 KB
Raw

Release Builds

Bada release builds are produced by .github/workflows/release.yml. The workflow is separate from normal CI and runs when:

  • a tag matching v* is pushed, such as v1.2.3

The workflow builds :app:assembleRelease, signs the APK with a keystore supplied through GitHub Actions secrets, uploads the signed APK as a workflow artifact, and attaches it to a matching GitHub Release when one exists for the tag. Release APK filenames come from the Gradle release variant and follow <applicationId>-<versionName>.apk, for example dev.bluehouse.bada-0.1.0-alpha01.apk. The decoded keystore lives in $RUNNER_TEMP/release.keystore for the Gradle step only and is removed before artifact upload.

Required GitHub Secrets

Configure these repository secrets before publishing a release:

Secret Purpose
KEYSTORE_B64 Base64-encoded Android release keystore file
KEYSTORE_PASSWORD Password for the keystore file
KEY_ALIAS Alias of the signing key inside the keystore
KEY_PASSWORD Password for the signing key

Do not commit keystore files or passwords. The workflow decodes KEYSTORE_B64 into $RUNNER_TEMP/release.keystore, which is outside the workspace and is discarded with the runner.

Generate A Keystore

Create a keystore locally if you do not already have one:

keytool -genkeypair \
  -v \
  -keystore release.keystore \
  -alias bada \
  -keyalg RSA \
  -keysize 2048 \
  -validity 10000

Record the keystore password, key alias, and key password in the matching GitHub secrets.

Encode The Keystore

GitHub secrets are text-only, so store the binary keystore as base64 text.

On macOS:

base64 -i release.keystore | pbcopy

On Linux:

base64 -w0 release.keystore

Paste the encoded value into the KEYSTORE_B64 repository secret.

Release Assets

The workflow always uploads the signed APK to the Actions run as a workflow artifact using the same filename as the on-disk release APK. If the tag already has a matching GitHub Release, the workflow also attaches that APK to the Release page.

Local Signed Build

For local release signing, pass the same values as Gradle properties or environment variables:

./gradlew :app:assembleRelease \
  -PKEYSTORE_FILE=/absolute/path/to/release.keystore \
  -PKEYSTORE_PASSWORD="$KEYSTORE_PASSWORD" \
  -PKEY_ALIAS="$KEY_ALIAS" \
  -PKEY_PASSWORD="$KEY_PASSWORD"

If no signing values are supplied, local release builds remain unsigned.