Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[No QA] Ensure bundle version strings are compatible before auto-merging CP PR #6199

Merged
merged 12 commits into from
Nov 17, 2021
Merged

[No QA] Ensure bundle version strings are compatible before auto-merging CP PR #6199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5fe290e
add function for checking bundleVersion strings
Jag96 Nov 3, 2021
40b9bac
move to separate workflow
Jag96 Nov 3, 2021
ccb26fb
update cherry-pick workflow to include check
Jag96 Nov 3, 2021
ca6f36f
rebuild actions
Jag96 Nov 3, 2021
f7e47d2
make PR if bundle versions don't match
Jag96 Nov 10, 2021
61f747f
update hash to fix verify workflow
Jag96 Nov 10, 2021
719f54d
fix indent
Jag96 Nov 11, 2021
38f55cd
update ref back to main
Jag96 Nov 11, 2021
2b4063f
add fallback
Jag96 Nov 16, 2021
e9b0c92
update actions
Jag96 Nov 16, 2021
ed931d5
add logging for easier debugging
Jag96 Nov 16, 2021
1557ae8
update actions
Jag96 Nov 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/actions/checkBundleVersionStringMatch/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: 'Check if Bundle Versions Match'
description: "Check if the CFBundleVersion string is compatible with the CFBundleShortVersionString"
outputs:
BUNDLE_VERSIONS_MATCH:
description: Whether or not the bundle versions match
runs:
using: 'node12'
main: './index.js'
16 changes: 16 additions & 0 deletions .github/actions/checkBundleVersionStringMatch/checkBundleVersionStringMatch.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
const core = require('@actions/core');
const {execSync} = require('child_process');
const {PLIST_PATH} = require('../../libs/nativeVersionUpdater');

const bundleVersion = execSync(`/usr/libexec/PlistBuddy -c "Print :CFBundleVersion" ${PLIST_PATH}`);
const shortBundleVersion = execSync(`/usr/libexec/PlistBuddy -c "Print :CFBundleShortVersionString" ${PLIST_PATH}`);

console.log(`Bundle Version: ${bundleVersion}`);
console.log(`Short Bundle Version: ${shortBundleVersion}`);
if (shortBundleVersion !== (bundleVersion.split('-') || [''])[0]) {
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: This comment is more for me to learn. I see in nativeVersionUpdater.js that the shortBundleVersion is obtained as following:

App/.github/libs/nativeVersionUpdater.js

Line 79 in fa2e8a9

const shortVersion = version.split('-')[0];

That means in terms of your example from the PR body: 1-1-1-0 this would be 1 and then on the next line we add another zero to the version:

App/.github/libs/nativeVersionUpdater.js

Line 80 in fa2e8a9

const cfVersion = version.includes('-') ? version.replace('-', '.') : `${version}.0`;

What I do not understand is taking the first - [0] element of the split would not check for the case you have described in the PR body:

  • Compatible bundle version strings: 1.1.1 and 1.1.1.0
  • Incompatible bundle version strings: 1.1.1 and 1.1.0.0

Thank you for explanation of this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, no worries! So in this case we're grabbing the version number from the info.plist, which has the versions formatted as x.x.x-x. So if the bundleVersion is 1.1.1-0 and the shortBundleVersion is 1.1.1, then they would match. Let me know if that makes sense!

Copy link
Contributor

Choose a reason for hiding this comment

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

Ahaa! That makes a lot of sense, did not catch that, thank you!

console.log('Bundle Versions do not match');
core.setOutput('BUNDLE_VERSIONS_MATCH', false);
} else {
console.log('Bundle Versions match');
core.setOutput('BUNDLE_VERSIONS_MATCH', true);
}
Loading