diff --git a/step.yml b/step.yml
index 1540a61..d6ee67d 100644
--- a/step.yml
+++ b/step.yml
@@ -1,14 +1,30 @@
title: Set Xcode Project Build Number
summary: |-
- Set the value of Bundle version in the project's Info.plist file to the specified version number.
+ Set the value of your iOS app's bundle version in the `Info.plist` file to the specified version number.
description: |-
- Sets the value of Bundle version in the specified Info.plist file. A great
- way to keep track of version when submitting bug reports.
-
- If your IPA contains multiple build targets ( e.g watch app, extensions ), they would need to have the same version number as your app's main target has.
- You need to add this step to your workflow for every build target one by one.
-
+ Set the value of your iOS app's bundle version in the `Info.plist` file to the specified version number. A great
+ way to keep track of versions when submitting bug reports.
+
+ If your IPA contains multiple build targets, they need to have the same version number as your app's main target has.
+ In that case, you need to add this Step to your Workflow for each build target: if you have, say, three targets, you need to have three instances of this Step in your Workflow.
If there are targets with different version numbers the app cannot be submitted for App Review or Beta App Review.
+
+ ### Configuring the Step
+
+ 1. Set the file path to the `Info.plist` file in the `Info.plist` file path input.
+ 1. Add a value in the Build Number input.
+ This sets the CFBundleVersion key to the specified value in the `Info.plist` file. The default value is the `$BITRISE_BUILD_NUMBER` Environment Variable.
+ 1. Optionally, add a value in the Version Number input. This will set the `CFBundleShortVersionString` key to the specified value in the `Info.plist` file. This input is not required.
+
+ ### Useful links
+
+ - [Build numbering and app versioning](https://devcenter.bitrise.io/builds/build-numbering-and-app-versioning/#setting-the-cfbundleversion-and-cfbundleshortversionstring-of-an-ios-app)
+ - [CFBundleversion in Apple documentation](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion)
+
+ ### Related Steps
+
+ - [Xcode Archive & Export for iOS](https://www.bitrise.io/integrations/steps/xcode-archive)
+ - [Set Android Manifest Version Code and Name](https://www.bitrise.io/integrations/steps/set-android-manifest-versions)
website: https://github.com/bitrise-io/set-xcode-build-number
source_code_url: https://github.com/bitrise-io/set-xcode-build-number
support_url: https://github.com/bitrise-io/set-xcode-build-number/issues
@@ -32,12 +48,11 @@ inputs:
- plist_path:
opts:
title: "Info.plist file path"
- summary: Path to the given target's Info.plist file. You need to use this step for each archivable target of your project.
+ summary: Path to the given target's Info.plist file. You need to use this Step for each archivable target of your project.
description: |
**NOTE:**
- If your IPA contains multiple build targets ( e.g watch app, extensions ), they would need to have the same version number as your app's main target has.
- You need to add this step to your workflow for every build target one by one.
-
+ If your IPA contains multiple build targets, they would need to have the same version number as your app's main target has.
+ You need to add this Step to your Workflow for each build target: if you have, say, three targets, you need to have three instances of this Step in your Workflow.
If there are targets with different version numbers the app cannot be submitted for App Review or Beta App Review.
is_required: true
- build_version: "$BITRISE_BUILD_NUMBER"
@@ -45,12 +60,10 @@ inputs:
title: "Build Number"
description: |
Set the CFBundleVersion to this value.
-
You can find this in Xcode:
-
- - Select the your project in Project navigator
- - Under General tab, in Identity section
- - Build field
+ - Select your project in the **Project navigator**
+ - Go to the **General** tab and then the **Identity** section
+ - **Build field**
is_required: true
- build_version_offset:
opts:
@@ -62,12 +75,10 @@ inputs:
title: "Version Number"
description: |
Set the CFBundleShortVersionString to this value.
-
You can find this in Xcode:
-
- - Select the your project in Project navigator
- - Under General tab, in Identity section
- - Version field
+ - Select your project in the **Project navigator**
+ - Go to the **General** tab and then the **Identity** section
+ - **Version field**
outputs:
- XCODE_BUNDLE_VERSION:
opts: