Get the build number of your project

This action will return the current build number set on your project.
You first have to set up your Xcode project, if you haven't done it already:

Supported platforms ios, mac
Author @Liquidsoul

1 Example

build_number = get_build_number(xcodeproj: "Project.xcodeproj")


Key Description Default
xcodeproj optional, you must specify the path to your main Xcode project if it is not in the project root directory
hide_error_when_versioning_disabled Used during fastlane init to hide the error message false

* = default value is dependent on the user's system

Lane Variables

Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The get_build_number action generates the following Lane Variables:

SharedValue Description
SharedValues::BUILD_NUMBER The build number

To get more information check the Lanes documentation.


To show the documentation in your terminal, run

fastlane action get_build_number


It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run get_build_number

To pass parameters, make use of the : symbol, for example

fastlane run get_build_number parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions