hg_commit_version_bump¶
This will commit a version bump to the hg repo
The mercurial equivalent of the commit_version_bump git action. Like the git version, it is 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, 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.
hg_commit_version_bump | |
---|---|
Supported platforms | ios, android, mac |
Author | @sjrmanning |
2 Examples¶
hg_commit_version_bump
hg_commit_version_bump(
message: "Version Bump", # create a commit with a custom message
xcodeproj: "./path/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here
)
Parameters¶
Key | Description | Default |
---|---|---|
message |
The commit message when committing the version bump | 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 |
test_dirty_files |
A list of dirty files passed in for testing | file1, file2 |
test_expected_files |
A list of expected changed files passed in for testing | file1, file2 |
* = default value is dependent on the user's system
To show the documentation in your terminal, run
fastlane action hg_commit_version_bump