feat: Add version code and version name as a config by farhaanbukhsh · Pull Request #507 · openedx/openedx-app-android

farhaanbukhsh · 2026-09-23T17:27:32Z

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.

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 · 2026-09-23T17:27:38Z

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.

tecoholic · 2026-09-25T10:53:12Z

+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.")
+}


@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?

The regex change came from the fact that it's possible people inter change version_code and version_name, hence I wanted to catch it at the right place and through an error which can be traced. But now that I think of it the regex check looks redundant.

Ah! I see. I think just reducing it to the following should be sufficient. If by mistake the VERSION_CODE is set to a string like "1.0.0", the isInteger() check should be sufficient to catch it.

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

Since this will catch it, we can drop the appVersionCode.toInteger() to just appVersionCode as well.

tecoholic · 2026-09-25T10:54:00Z

        targetSdk target_sdk_version
-        versionCode 1
-        versionName "1.0.0"
+        versionCode appVersionCode.toInteger()


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

This in my mind is more of a safety check.

tecoholic · 2026-09-29T06:54:16Z

+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) {


Suggested change

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

def appVersionCode = config.getOrDefault("VERSION_CODE", 1)

def appVersionName = config.getOrDefault("VERSION_NAME", "1.0.0")

if (!appVersionCode.isInteger() || appVersionCode < 1 || appVersionCode > 2100000000) {

!appVersionCode.isInteger() this wouldn't be needed if we don't convert it to string.

tecoholic · 2026-09-29T06:55:12Z

        targetSdk target_sdk_version
-        versionCode 1
-        versionName "1.0.0"
+        versionCode appVersionCode.toInteger()


Suggested change

versionCode appVersionCode.toInteger()

versionCode appVersionCode

tecoholic · 2026-09-30T10:49:39Z

+def appVersionCode = config.getOrDefault("VERSION_CODE", 1)
+def appVersionName = config.getOrDefault("VERSION_NAME", "1.0.0")
+
+if (appVersionCode.toInteger() < 1 || appVersionCode.toInteger() > 2100000000) {


@farhaanbukhsh I am really sorry for being pedantic about this. Can we have either:

toInteger() be at the def appVersionCode OR

fail the if check when appVersionCode is not an integer

Because, currently, this line treats it as a string and the rest of the file treats it as an Int. It would be best to make it consistent.

I have removed toInteger() from the codebase since the getOrDefault can infer the type, the intention of toInteger was to just put an additional check on the data type.

tecoholic · 2026-10-01T01:38:49Z

+VERSION_NAME: '1.0.1'
+```
+
+- `VERSION_CODE` sets Android's `versionCode`. It must be an integer from `1` to `2100000000`; invalid values fail during Gradle configuration. Integer values and quoted integer strings are supported.


Suggested change

- `VERSION_CODE` sets Android's `versionCode`. It must be an integer from `1` to `2100000000`; invalid values fail during Gradle configuration. Integer values and quoted integer strings are supported.

- `VERSION_CODE` sets Android's `versionCode`. It must be an integer from `1` to `2100000000`; invalid values fail during Gradle configuration.

tecoholic

@farhaanbukhsh LGTM. 👍

Unfortunately, I didn't test this and I don't have the full Android SDK setup of a phone to properly test this.

kaustavb12

👍

I tested this: As described in the testing instructions
I read through the code
I checked for accessibility issues
Includes documentation

farhaanbukhsh · 2026-10-14T10:49:55Z

@PavloNetrebchuk @volodymyr-chekyrta gentle ping for review here :) thank you in advance.

feat: Add version code and version name as a config

987b221

Signed-off-by: Farhaan Bukhsh <farhaan@opencraft.com>

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 added this to Contributions Sep 23, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Sep 23, 2026

farhaanbukhsh mentioned this pull request Sep 23, 2026

feat: Add version code and version name as a config open-craft/openedx-app-android#18

Merged

tecoholic reviewed Sep 25, 2026

View reviewed changes

tecoholic suggested changes Sep 29, 2026

View reviewed changes

farhaanbukhsh added 2 commits September 29, 2026 19:15

fixup! feat: Add version code and version name as a config

c104a09

fixup! feat: Add version code and version name as a config

7786788

tecoholic reviewed Sep 30, 2026

View reviewed changes

fixup! feat: Add version code and version name as a config

b56e6af

tecoholic reviewed Oct 1, 2026

View reviewed changes

fixup! feat: Add version code and version name as a config

4fddd95

kaustavb12 approved these changes Oct 1, 2026

View reviewed changes

itsjeyd moved this from In Eng Review to Ready for Review in Contributions Oct 14, 2026

itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Oct 14, 2026

itsjeyd requested review from PavloNetrebchuk and volodymyr-chekyrta October 14, 2026 11:07

	versionCode appVersionCode.toInteger()
	versionCode appVersionCode

	- `VERSION_CODE` sets Android's `versionCode`. It must be an integer from `1` to `2100000000`; invalid values fail during Gradle configuration. Integer values and quoted integer strings are supported.
	- `VERSION_CODE` sets Android's `versionCode`. It must be an integer from `1` to `2100000000`; invalid values fail during Gradle configuration.

Conversation

farhaanbukhsh commented Sep 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

openedx-webhooks commented Sep 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tecoholic left a comment

Choose a reason for hiding this comment

Uh oh!

kaustavb12 left a comment

Choose a reason for hiding this comment

Uh oh!

farhaanbukhsh commented Oct 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

farhaanbukhsh commented Sep 23, 2026 •

edited

Loading