commit_version_bump¶
Creates a 'Version Bump' commit. Run after increment_build_number
This action will create a 'Version Bump' commit in your repo. Useful in conjunction with
increment_build_number
.
It checks the repo to make sure that only the relevant files have changed. These are the files thatincrement_build_number
(agvtool
) touches:
- All
.plist
files- The
.xcodeproj/project.pbxproj
fileThen commits those files to the repo.
Customize the message with the:message
option. It defaults to 'Version Bump'.
If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the ipa and or sigh actions, then you can use the clean_build_artifacts action to clean those temporary files up before running this action.
commit_version_bump | |
---|---|
Supported platforms | ios, mac |
Author | @lmirosevic |
7 Examples¶
commit_version_bump
commit_version_bump(
message: "Version Bump",# create a commit with a custom message
xcodeproj: "./path/to/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here
)
commit_version_bump(
settings: true # Include Settings.bundle/Root.plist
)
commit_version_bump(
settings: "About.plist" # Include Settings.bundle/About.plist
)
commit_version_bump(
settings: %w[About.plist Root.plist] # Include more than one plist from Settings.bundle
)
commit_version_bump(
include: %w[package.json custom.cfg] # include other updated files as part of the version bump
)
commit_version_bump(
ignore: /OtherProject/ # ignore files matching a regular expression
)
Parameters¶
Key | Description | Default |
---|---|---|
message |
The commit message when committing the version bump | |
xcodeproj |
The path to your project file (Not the workspace). If you have only one, this is optional | |
force |
Forces the commit, even if other files than the ones containing the version number have been modified | false |
settings |
Include Settings.bundle/Root.plist with version bump | false |
ignore |
A regular expression used to filter matched plist files to be modified | |
include |
A list of extra files to be included in the version bump (string array or comma-separated string) | [] |
* = default value is dependent on the user's system
To show the documentation in your terminal, run
fastlane action commit_version_bump