Skip to content

Commit c402cfa

Browse files
committed
expand doc
1 parent 60b110a commit c402cfa

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

crates/tauri-cli/config.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
]
3232
},
3333
"version": {
34-
"description": "App version. It is a semver version number or a path to a `package.json` file containing the `version` field.\n\n If removed the version number from `Cargo.toml` is used.\n It's recommended to manage the app versioning in the Tauri config.\n\n Translates to the bundle's CFBundleShortVersionString property on macOS and iOS,\n and is used as the default CFBundleVersion value when `bundle > macOS > bundleVersion` and `bundle > iOS > bundleVersion` are not set.\n\n By default version 1.0 is used on Android.",
34+
"description": "App version. It is a semver version number or a path to a `package.json` file containing the `version` field.\n\n If removed the version number from `Cargo.toml` is used.\n It's recommended to manage the app versioning in the Tauri config.\n\n ## Platform-specific\n\n - **macOS**: Translates to the bundle's CFBundleShortVersionString property and is used as the default CFBundleVersion.\n You can set an specific bundle version using [`bundle > macOS > bundleVersion`](MacConfig::bundle_version).\n - **iOS**: Translates to the bundle's CFBundleShortVersionString property and is used as the default CFBundleVersion.\n You can set an specific bundle version using [`bundle > iOS > bundleVersion`](IosConfig::bundle_version).\n The `tauri ios build` CLI command has a `--build-number <number>` option that lets you append a build number to the app version.\n - **Android**: By default version 1.0 is used. You can set a version code using [`bundle > android > versionCode`](AndroidConfig::version_code).\n\n By default version 1.0 is used on Android.",
3535
"type": [
3636
"string",
3737
"null"

crates/tauri-schema-generator/schemas/config.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
]
3232
},
3333
"version": {
34-
"description": "App version. It is a semver version number or a path to a `package.json` file containing the `version` field.\n\n If removed the version number from `Cargo.toml` is used.\n It's recommended to manage the app versioning in the Tauri config.\n\n Translates to the bundle's CFBundleShortVersionString property on macOS and iOS,\n and is used as the default CFBundleVersion value when `bundle > macOS > bundleVersion` and `bundle > iOS > bundleVersion` are not set.\n\n By default version 1.0 is used on Android.",
34+
"description": "App version. It is a semver version number or a path to a `package.json` file containing the `version` field.\n\n If removed the version number from `Cargo.toml` is used.\n It's recommended to manage the app versioning in the Tauri config.\n\n ## Platform-specific\n\n - **macOS**: Translates to the bundle's CFBundleShortVersionString property and is used as the default CFBundleVersion.\n You can set an specific bundle version using [`bundle > macOS > bundleVersion`](MacConfig::bundle_version).\n - **iOS**: Translates to the bundle's CFBundleShortVersionString property and is used as the default CFBundleVersion.\n You can set an specific bundle version using [`bundle > iOS > bundleVersion`](IosConfig::bundle_version).\n The `tauri ios build` CLI command has a `--build-number <number>` option that lets you append a build number to the app version.\n - **Android**: By default version 1.0 is used. You can set a version code using [`bundle > android > versionCode`](AndroidConfig::version_code).\n\n By default version 1.0 is used on Android.",
3535
"type": [
3636
"string",
3737
"null"

crates/tauri-utils/src/config.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2863,8 +2863,14 @@ pub struct Config {
28632863
/// If removed the version number from `Cargo.toml` is used.
28642864
/// It's recommended to manage the app versioning in the Tauri config.
28652865
///
2866-
/// Translates to the bundle's CFBundleShortVersionString property on macOS and iOS,
2867-
/// and is used as the default CFBundleVersion value when `bundle > macOS > bundleVersion` and `bundle > iOS > bundleVersion` are not set.
2866+
/// ## Platform-specific
2867+
///
2868+
/// - **macOS**: Translates to the bundle's CFBundleShortVersionString property and is used as the default CFBundleVersion.
2869+
/// You can set an specific bundle version using [`bundle > macOS > bundleVersion`](MacConfig::bundle_version).
2870+
/// - **iOS**: Translates to the bundle's CFBundleShortVersionString property and is used as the default CFBundleVersion.
2871+
/// You can set an specific bundle version using [`bundle > iOS > bundleVersion`](IosConfig::bundle_version).
2872+
/// The `tauri ios build` CLI command has a `--build-number <number>` option that lets you append a build number to the app version.
2873+
/// - **Android**: By default version 1.0 is used. You can set a version code using [`bundle > android > versionCode`](AndroidConfig::version_code).
28682874
///
28692875
/// By default version 1.0 is used on Android.
28702876
#[serde(deserialize_with = "version_deserializer", default)]

0 commit comments

Comments
 (0)