Skip to content

build(apk): publish on jitpack#236

Closed
jo-elimu wants to merge 8 commits intomainfrom
235-publish-apk-on-jitpack
Closed

build(apk): publish on jitpack#236
jo-elimu wants to merge 8 commits intomainfrom
235-publish-apk-on-jitpack

Conversation

@jo-elimu
Copy link
Copy Markdown
Member

@jo-elimu jo-elimu commented Apr 15, 2025

Issue Number

Purpose

Technical Details

Screenshots

Testing Instructions

Regression Tests

  • 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)

Summary by CodeRabbit

  • Documentation
    • Updated README with a JitPack release badge and simplified release instructions. Adjusted project tagline emoji order.
  • Chores
    • Updated version numbers to the next snapshot iteration for app and utils modules.
    • Added publishing configuration to support publishing the release APK to Maven repositories.
    • Downgraded Android Gradle plugin version from 8.9.1 to 8.8.1.
    • Upgraded Gradle wrapper version from 8.11.1 to 8.13.
    • Added SPDX license identifiers to Gradle wrapper scripts and improved path resolution in the gradlew script.

@jo-elimu jo-elimu self-assigned this Apr 15, 2025
@jo-elimu jo-elimu requested a review from a team as a code owner April 15, 2025 08:52
@jo-elimu jo-elimu linked an issue Apr 15, 2025 that may be closed by this pull request
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 15, 2025

Walkthrough

This update modifies the release process and versioning for the project. The README is revised to simplify release instructions, directing users to use a GitHub Actions workflow and manual GitHub release creation, and adds a JitPack release badge. The app/build.gradle and utils/build.gradle files are updated to increment the version to the next snapshot iteration and add Maven publishing configuration in app/build.gradle to enable publishing the release APK to Maven repositories, specifically facilitating JitPack integration. These changes align with elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.

Changes

Files/Paths Change Summary
README.md Updated release instructions, added JitPack badge, changed emoji order in tagline.
app/build.gradle, utils/build.gradle Incremented versionCode and versionName to "1.2.40-SNAPSHOT"; added Maven publication for APK in app/build.gradle; configured publish task dependency.
build.gradle Downgraded Android Gradle plugin version from 8.9.1 to 8.8.1.
gradle/wrapper/gradle-wrapper.properties Upgraded Gradle distribution version from 8.11.1 to 8.13.
gradlew, gradlew.bat Added SPDX license identifier comments; updated gradlew script's APP_HOME path resolution and source URL comment.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant GitHub Release
    participant JitPack

    Developer->>GitHub Actions: Run gradle-release.yml workflow
    GitHub Actions->>GitHub Release: Tag new release version
    Developer->>GitHub Release: Manually create release from tag
    GitHub Release->>JitPack: JitPack builds and publishes APK
    Developer->>JitPack: Verify release status
Loading

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Enable publishApkPublicationToMavenLocal on JitPack (#235)

Possibly related PRs

  • Release 1.2.34 #208: Both PRs update the versionCode and versionName in app/build.gradle and utils/build.gradle to increment the snapshot version, but the main PR additionally adds a Maven publishing configuration which is not present in the retrieved PR.
  • chore: release 1.2.31 #198: Both PRs modify the versionName and Maven publication version in app/build.gradle and utils/build.gradle to update the version, but the main PR adds publishing configuration and changes the release workflow while the retrieved PR only updates version strings for a release.
  • docs: snapshot versions #233: Both PRs update README documentation related to versioning and publishing; this PR simplifies release instructions and adds Maven publishing configuration, while the retrieved PR focuses on testing snapshot versions of the utils library.

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 16aa12f and 6ae8375.

📒 Files selected for processing (1)
  • gradle/wrapper/gradle-wrapper.properties (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • gradle/wrapper/gradle-wrapper.properties
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test (28)
  • GitHub Check: test (29)

🪧 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.

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 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.

@jo-elimu jo-elimu marked this pull request as draft April 15, 2025 09:34
@jo-elimu jo-elimu closed this Apr 27, 2025
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.

Publish APK on JitPack

1 participant