Skip to content

docs(package_info_plus): Explain why buildNumber returns version when no build number defined #1729

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

Merged
vbuberen merged 1 commit into from
Apr 28, 2023
Merged

docs(package_info_plus): Explain why buildNumber returns version when no build number defined #1729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions docs/package_info_plus/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ requires the Xcode build folder to be rebuilt after changes to the version strin
Clean the Xcode build folder with:
`XCode Menu -> Product -> (Holding Option Key) Clean build folder`.

#### Plugin returns package version in `buildNumber` when no build number specified in pubspec.yaml

Plugin doesn't modify the output of iOS. In this case `buildNumber` in the plugin is CFBundleVersion in iOS. This property returns version when build number is not specified.buildNumber
See [CFBundleVersion docs](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion) for more inf.

### Android (and potentially all platforms)

Calling to `PackageInfo.fromPlatform()` before the `runApp()` call will cause an exception.
Expand Down
2 changes: 2 additions & 0 deletions packages/package_info_plus/package_info_plus/lib/package_info_plus.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ class PackageInfo {
final String version;

/// The build number. `CFBundleVersion` on iOS, `versionCode` on Android.
/// Note, on iOS if an app has no buildNumber specified this property will return version
/// Docs about CFBundleVersion: https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion
final String buildNumber;

/// The build signature. Empty string on iOS, signing key signature (hex) on Android.
Expand Down