increment_version_number
Increment the version number of your project
This action will increment the version number.
You first have to set up your Xcode project, if you haven't done it already: https://developer.apple.com/library/ios/qa/qa1827/_index.html.
| increment_version_number | |
|---|---|
| Supported platforms | ios, mac |
| Author | @serluca |
| Returns | The new version number |
7 Examples
increment_version_number # Automatically increment version number
increment_version_number(
bump_type: "patch" # Automatically increment patch version number
)
increment_version_number(
bump_type: "minor" # Automatically increment minor version number
)
increment_version_number(
bump_type: "major" # Automatically increment major version number
)
increment_version_number(
version_number: "2.1.1" # Set a specific version number
)
increment_version_number(
version_number: "2.1.1", # specify specific version number (optional, omitting it increments patch version number)
xcodeproj: "./path/to/MyApp.xcodeproj" # (optional, you must specify the path to your main Xcode project if it is not in the project root directory)
)
version = increment_version_number
Parameters
| Key | Description | Default |
|---|---|---|
bump_type |
The type of this version bump. Available: patch, minor, major | bump |
version_number |
Change to a specific version. This will replace the bump type value | |
xcodeproj |
optional, you must specify the path to your main Xcode project if it is not in the project root directory |
* = 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 increment_version_number action generates the following Lane Variables:
| SharedValue | Description |
|---|---|
SharedValues::VERSION_NUMBER |
The new version number |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
fastlane action increment_version_number
CLI
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 increment_version_number
To pass parameters, make use of the : symbol, for example
fastlane run increment_version_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