Skip to content

DEV-1395: Release workflow for ShimmerCapture - #146

Merged
MAzalya merged 3 commits into
masterfrom
ShimmerCapture_release_workflow
Nov 2, 2026
Merged

MAzalya merged 3 commits into
masterfrom
ShimmerCapture_release_workflow

Conversation

@MAzalya

@MAzalya MAzalya commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Automates the Confluence procedure ShimmerCapture Android Release (shimmerServiceExample) as a dispatch-only workflow, Release ShimmerCapture (.github/workflows/release-shimmercapture.yml).

How to release: shimmerServiceExample/RELEASING.md has every step, from the uprev PR to sending the draft for review in Play Console, plus failures and their fixes and the secrets. It is linked from the module README, the workflow header and AGENTS.md.

What a run does

  1. Checks (before building): fails if ShimmerCapture_v<versionName> is already tagged, if versionCode is not higher than the previous ShimmerCapture release's (Play rejects a code it has seen), or if MainActivity.appReleaseType is not PUBLIC.
  2. Builds the signed release APK of shimmerServiceExample, signing with the android.injected.signing.* properties that Android Studio's Generate Signed APK uses, so build.gradle needs no signing config. Checks the APK's versionName/versionCode with aapt2 and its signature with apksigner.
  3. Tags ShimmerCapture_v<versionName> and creates a GitHub pre-release with the APK and generated notes since the previous ShimmerCapture tag (pre-release, like v1.3.3, so the Android API release stays Latest).
  4. Optional, google_play ticked: uploads the same APK to Play's Production track as a draft. Someone still reviews it in Play Console and clicks Send changes for review.

dry_run builds without publishing, from any branch. PRs that change the workflow dry-run it unsigned: the keystore is only used on manual runs, because a PR build runs the PR's own Gradle scripts.

The version stays committed in build.gradle rather than typed into the run (unlike release.yml), because Play needs a rising versionCode and the file is the only record of the last one. So each release still starts with an uprev PR raising versionName and versionCode; the workflow refuses to run if that was forgotten. This PR carries the uprev for the next release (1.3.4, versionCode 35) as its own commit.

Repository secrets

All added 2 Nov 2026:

  • SHIMMERCAPTURE_KEYSTORE_BASE64: the upload keystore, base64-encoded
  • SHIMMERCAPTURE_KEYSTORE_PASSWORD, SHIMMERCAPTURE_KEY_ALIAS, SHIMMERCAPTURE_KEY_PASSWORD
  • GOOGLE_PLAY_SERVICE_ACCOUNT_JSON: JSON key of the service account github-shimmercapture-release, in the Play account's Google Cloud project Google Play Android Developer. Invited in Play Console (Users and permissions) on 2 Nov 2026 with release rights on ShimmerCapture only; new permissions can take up to a day to apply.

Signing with the real keystore is checked by a dry_run on master after merge; it prints the certificate SHA-256 to compare with Play Console's upload certificate.

Tested locally

  • :shimmerServiceExample:assembleRelease passes, including lintVitalRelease, so the DEV-379 lint error no longer occurs.
  • A build signed with a throwaway keystore produced shimmerServiceExample-release.apk, and the aapt2/apksigner checks read it correctly.
  • The version/release-type checks read the expected values (1.3.4 / 35 vs 34 at v1.3.3, PUBLIC).
  • Not yet run on GitHub: this PR's own dry run is the first.

🤖 Generated with Claude Code

MAzalya and others added 2 commits November 2, 2026 14:14
Automates the Confluence procedure "ShimmerCapture Android Release
(shimmerServiceExample)": builds the shimmerServiceExample release APK,
signed with the upload keystore from repository secrets the same way
Android Studio's Generate Signed APK does, tags ShimmerCapture_v<versionName>
and creates the GitHub pre-release with the APK. With google_play ticked it
also uploads the APK to Play's Production track as a draft, to be sent for
review in Play Console.

The version stays committed in build.gradle: the workflow refuses a version
already tagged, a versionCode no higher than the last release's, and a
build not set to APP_RELEASE_TYPE.PUBLIC. PRs that change the workflow
dry-run it unsigned.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@MAzalya MAzalya changed the title Release workflow for ShimmerCapture, and 1.3.4 DEV-1395: Release workflow for ShimmerCapture, and 1.3.4 Nov 2, 2026
@MAzalya MAzalya changed the title DEV-1395: Release workflow for ShimmerCapture, and 1.3.4 DEV-1395: Release workflow for ShimmerCapture Nov 2, 2026
RELEASING.md walks through a release: the uprev PR, an optional signed dry run, the workflow run, sending the draft for review in Play Console, failures and their fixes, and the secrets. Linked from the module README, the workflow header and AGENTS.md.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@MAzalya
MAzalya merged commit 97094de into master Nov 2, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants