[ENG-9] [eas-cli] implement automatic version bumping for ios builds #231

dsokal · 2021-02-10T13:19:29Z

Why

https://linear.app/expo/issue/ENG-9/automatic-version-bumping

For iOS builds, we want to automatically bump CFBundleShortVersionString or CFBundleVersion for every build. This lets users run fewer redundant builds. Usually, users forget to bump the version on their own. They find out that they forgot to bump the version after the build completes and .ipa cannot be uploaded to App Store.

How

I added a new configuration field in iOS build profiles - autoIncrement. Possible values:
- true - the same as "buildNumber"
- false - default, does not bump any version
- "version" - bumps CFBundleShortVersionString
- "buildNumber" - bumps CFBundleVersion
Versions are bumped on the client side.
- For generic projects, both app.json and Info.plist are updated.
- For managed projects, app.json is updated.
EAS CLI assumes the following format of versions:
- CFBundleShortVersionString is a semver. A new version is created by bumping the patch version. E.g. 1.0.0 -> 1.0.1
- CFBundleVersion is a semver-like string (e.g. 1, 1.2, 1.2.3, 1.2.3.4, and so on). A new version is created by adding 1 to the last component of the string. E.g. 1.2.3.29 -> 1.2.3.30
If EAS CLI detects another format of versions, the user is prompted to specify the next version.
Currently, there is no support for app.config.js. eas build fails if the project is configured with it and autoIncrement != false.

Test Plan

Unit tests
Manual tests
- Generic project
- Managed project

github-actions · 2021-02-11T10:58:32Z

Size Change: +103 kB (0%)

Total Size: 35.9 MB

Filename	Size	Change
`./packages/eas-cli/dist/eas-linux-x64.tar.gz`	35.9 MB	+103 kB (0%)

_{compressed-size-action}

brentvatne · 2021-02-12T04:51:05Z

let's call the field autoIncrement instead of autoincrement - since they are two separate words (sometimes joined with a dash) we should use camel casing

wkozyra95 · 2021-02-12T10:29:54Z

packages/eas-cli/src/build/build.ts

-    // Currently we are only updaing runtime version durring build, but if it changes in a future
-    // this message should also contain more info on that (or be more generic)
-    await reviewAndCommitChangesAsync(`Update runtime version in the ${projectType} project`, {
+    await reviewAndCommitChangesAsync(`[EAS Build] Configure project`, {


For build:configure we have

[RequestedPlatform.Android]: 'Configure EAS Build for Android', [RequestedPlatform.iOS]: 'Configure EAS Build for iOS', [RequestedPlatform.All]: 'Configure EAS Build',

This commit should clearly state that this is commit that happens before build and not build:configure

wkozyra95 · 2021-02-12T11:07:24Z

packages/eas-cli/src/build/ios/version.ts

+    }
+  } else {
+    const buildNumber = IOSConfig.Version.getBuildNumber(exp);
+    if (buildNumber.match(/^\d+$/)) {


If I remember correctly we discussed that in the case of build number we require the last segment to be a number but except that we should support all formats allowed for this value.

wkozyra95 · 2021-02-12T11:27:12Z

packages/eas-json/src/EasJsonSchema.ts

 });

 const iOSManagedSchema = Joi.object({
  workflow: Joi.string().valid('managed').required(),
  credentialsSource: Joi.string().valid('local', 'remote', 'auto').default('auto'),
  releaseChannel: Joi.string(),
  distribution: Joi.string().valid('store', 'internal').default('store'),
+  autoIncrement: Joi.alternatives()
+    .try(Joi.boolean(), Joi.string().valid('version', 'buildNumber'))
+    .default('buildNumber'),


Suggested change

.default('buildNumber'),

.default(false),

wkozyra95 · 2021-02-12T11:46:31Z

packages/eas-cli/src/build/utils/appJson.ts

+  modifyConfig: (config: any) => void
+): Promise<void> {
+  const paths = ExpoConfig.getConfigFilePaths(projectDir);
+  assert(paths.staticConfigPath, "can't update dynamic configs");


Make sure that this condition is handled earlier with proper error message sth along the lines autoIncrement options is not supported with dynamic config

(optional) when you check that you could also verify if the version in config is the same as in static config

wkozyra95 · 2021-02-12T13:17:10Z

packages/eas-cli/src/build/ios/version.ts

+  await writePlistAsync(infoPlistPath, infoPlist);
+}
+
+function ensureDynamicConfigDoesNotExist(projectDir: string): void {


Suggested change

function ensureDynamicConfigDoesNotExist(projectDir: string): void {

function ensureStaticConfigDoesExist(projectDir: string): void {

dsokal force-pushed the @dsokal/automatic-version-bumping branch from c9cce85 to b05a134 Compare February 10, 2021 13:44

dsokal force-pushed the @dsokal/automatic-version-bumping branch 2 times, most recently from 1935369 to 153c30c Compare February 11, 2021 12:50

dsokal changed the title ~~[wip] automatic version bumping~~ [eas-cli] implement automatic version bumping for ios builds Feb 11, 2021

dsokal changed the title ~~[eas-cli] implement automatic version bumping for ios builds~~ [ENG-9] [eas-cli] implement automatic version bumping for ios builds Feb 11, 2021

dsokal marked this pull request as ready for review February 11, 2021 13:41

dsokal requested review from wkozyra95 and brentvatne February 11, 2021 13:41

[eas-cli] implement automatic version bumping for ios builds

611365c

dsokal force-pushed the @dsokal/automatic-version-bumping branch from 153c30c to 611365c Compare February 11, 2021 14:15

[eas-cli] autoincrement -> autoIncrement

e9b65e5

dsokal mentioned this pull request Feb 12, 2021

[ENG-9] [docs] EAS Build: document autoIncrement option for iOS builds expo/expo#11927

Merged

[eas-cli] code style fix

0264e5a

wkozyra95 suggested changes Feb 12, 2021

View reviewed changes

wkozyra95 reviewed Feb 12, 2021

View reviewed changes

[eas-cli][eas-json] address PR feedback

de09a45

dsokal requested a review from wkozyra95 February 12, 2021 13:10

wkozyra95 approved these changes Feb 12, 2021

View reviewed changes

more pr feedback

7fe9ffa

dsokal merged commit 1ac0af5 into main Feb 12, 2021

dsokal deleted the @dsokal/automatic-version-bumping branch February 12, 2021 13:37

jkhales mentioned this pull request Sep 24, 2021

[eas-cli] Enable autoIncrementing on Android #645

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENG-9] [eas-cli] implement automatic version bumping for ios builds #231

[ENG-9] [eas-cli] implement automatic version bumping for ios builds #231

dsokal commented Feb 10, 2021 •

edited

Loading

github-actions bot commented Feb 11, 2021 •

edited

Loading

brentvatne commented Feb 12, 2021

wkozyra95 Feb 12, 2021

wkozyra95 Feb 12, 2021

wkozyra95 Feb 12, 2021

wkozyra95 Feb 12, 2021 •

edited

Loading

dsokal Feb 12, 2021

wkozyra95 Feb 12, 2021

	function ensureDynamicConfigDoesNotExist(projectDir: string): void {
	function ensureStaticConfigDoesExist(projectDir: string): void {

[ENG-9] [eas-cli] implement automatic version bumping for ios builds #231

[ENG-9] [eas-cli] implement automatic version bumping for ios builds #231

Conversation

dsokal commented Feb 10, 2021 • edited Loading

Why

How

Test Plan

github-actions bot commented Feb 11, 2021 • edited Loading

brentvatne commented Feb 12, 2021

wkozyra95 Feb 12, 2021

Choose a reason for hiding this comment

wkozyra95 Feb 12, 2021

Choose a reason for hiding this comment

wkozyra95 Feb 12, 2021

Choose a reason for hiding this comment

wkozyra95 Feb 12, 2021 • edited Loading

Choose a reason for hiding this comment

dsokal Feb 12, 2021

Choose a reason for hiding this comment

wkozyra95 Feb 12, 2021

Choose a reason for hiding this comment

dsokal commented Feb 10, 2021 •

edited

Loading

github-actions bot commented Feb 11, 2021 •

edited

Loading

wkozyra95 Feb 12, 2021 •

edited

Loading