Skip to content

feat: Add version code and version name as a config - #507

Open
farhaanbukhsh wants to merge 1 commit into
openedx:mainfrom
open-craft:farhaan/change-version-config
Open

farhaanbukhsh wants to merge 1 commit into
openedx:mainfrom
open-craft:farhaan/change-version-config

Conversation

@farhaanbukhsh

@farhaanbukhsh farhaanbukhsh commented Sep 23, 2026 •

Copy link
Copy Markdown
Member

Description

The PR helps to configure the version code and version name through config files since releasing the app always changing the code is cumbersome while doing that with a config variables makes life easier.

Testing instructions

  • Check out the PR in a clean checkout.
  • Configure the Android SDK and Java as required by the project.
  • Make sure you have dummy config file as pointed out in the readme
  • Set these top-level values in the development config:
  VERSION_CODE: 42                                                                                                                                                                                                    
  VERSION_NAME: "2.3.4-test"                                                                                                                                                                                          
  • Build:
  ./gradlew :app:assembleDevelopDebug 
  • Inspect the generated APK using Android Studio’s Build → Analyze APK, then open AndroidManifest.xml.
image
  • Manifest file should show the set version and code

Private Ref: https://tasks.opencraft.com/browse/BB-10453

Signed-off-by: Farhaan Bukhsh <farhaan@opencraft.com>
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Sep 23, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @farhaanbukhsh!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Comment thread app/build.gradle
Comment on lines +3 to +9
def appVersionCode = config.getOrDefault("VERSION_CODE", 1)?.toString()
def appVersionName = config.getOrDefault("VERSION_NAME", "1.0.0")

if (!(appVersionCode ==~ /[0-9]+/) || !appVersionCode.isInteger() ||
appVersionCode.toInteger() < 1 || appVersionCode.toInteger() > 2100000000) {
throw new GradleException("VERSION_CODE must be an integer between 1 and 2100000000 in the YAML config.")
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@farhaanbukhsh I am very confused here. Why are we converting VERSION_CODE to string, compare against a regex, check !isInt, to cast toInt and then validate the range?

Why can't we simply do?

def appVersionCode = config.getOrDefault("VERSION_CODE", 1)
if (!appVersionCode.isInteger() || appVersion < 1 || appVersion > 2100000000) {
    throw...
}

Is it something with the way Gradle parses the YAML? Does it not preserve integers?

Comment thread app/build.gradle
targetSdk target_sdk_version
versionCode 1
versionName "1.0.0"
versionCode appVersionCode.toInteger()

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related to above comment, why do we need to keep it as a string and cast to int every time we need this value?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants