build: apk signing

[jo-elimu]

Issue Number

• Resolves Add APK signing config to release workflow #324

Purpose

Technical Details

Screenshots

Testing Instructions

Regression Tests

• I tested my changes on Android 16 (API 36)
• I tested my changes on Android 15 (API 35)
• I tested my changes on Android 14 (API 34)
• I tested my changes on Android 13 (API 33)
• I tested my changes on Android 12L (API 32)
• I tested my changes on Android 12 (API 31)
• I tested my changes on Android 11 (API 30)
• I tested my changes on Android 10 (API 29)
• I tested my changes on Android 9 (API 28)
• I tested my changes on Android 8.1 (API 27)
• I tested my changes on Android 8.0 (API 26)

UI Tests

• I tested my changes on a 6-7" screen (▯ portrait orientation)
• I tested my changes on a 6-7" screen (▭ landscape orientation)
• I tested my changes on a 7-8" screen (▯ portrait orientation)
• I tested my changes on a 7-8" screen (▭ landscape orientation)
• I tested my changes on a 9-10" screen (▯ portrait orientation)
• I tested my changes on a 9-10" screen (▭ landscape orientation)

Content Tests

• I tested my changes with English content (eng.elimu.ai)
• I tested my changes with Hindi content (hin.elimu.ai)
• I tested my changes with Tagalog content (tgl.elimu.ai)
• I tested my changes with Thai content (tha.elimu.ai)
• I tested my changes with Vietnamese content (vie.elimu.ai)

Summary by CodeRabbit

• New Features

  • Automated creation, signing, and uploading of release APKs to GitHub Releases.
  • Automatic notification to web API endpoints for multiple languages with the new APK version and download link.

• Documentation

  • Updated release instructions to verify new releases on the GitHub releases page instead of JitPack.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The Gradle release workflow has been enhanced with two new jobs: one for building and signing the release APK (release_apk), and another for notifying a web API with the APK's URL (notify_webapp_api). The job responsible for creating a git tag now outputs the version name using the updated GitHub Actions syntax. The release_apk job checks out the repository at the tag, assembles the APK, signs it using provided secrets, and uploads it to the corresponding GitHub release. The notify_webapp_api job iterates over language codes, sending the APK URL to a web API. Documentation was updated to verify releases via GitHub instead of JitPack.

Changes

Files/Paths	Change Summary
.github/workflows/gradle-release.yml	Added jobs: release_apk (builds, signs, uploads APK), notify_webapp_api (notifies API); updated output syntax and environment formatting.
README.md	Updated release verification instructions to refer to GitHub releases instead of JitPack.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Gradle
    participant APK Signer
    participant GitHub Release
    participant WebApp API

    Developer->>GitHub Actions: Trigger release workflow
    GitHub Actions->>Gradle: Run getVersionName (create_git_tag)
    Gradle-->>GitHub Actions: Return version name (tagName)
    GitHub Actions->>GitHub Actions: release_apk (depends on tag)
    GitHub Actions->>GitHub Actions: Checkout repo at tag
    GitHub Actions->>Gradle: Assemble release APK
    Gradle-->>GitHub Actions: APK artifact
    GitHub Actions->>APK Signer: Sign APK with credentials
    APK Signer-->>GitHub Actions: Signed APK
    GitHub Actions->>GitHub Release: Upload signed APK
    GitHub Release-->>GitHub Actions: APK file URL
    GitHub Actions->>GitHub Actions: notify_webapp_api (matrix over language codes)
    GitHub Actions->>WebApp API: PUT APK URL for each language code

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add APK signing config to release workflow (#324): Build and sign APK in workflow	✅

---

elimu.ai's mission is to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eee8730 and 59b28bc.

📒 Files selected for processing (2)

• .github/workflows/gradle-release.yml (3 hunks)
• README.md (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.