Commitizen version provider for Xcode projects.
Project description
Commitizen Xcode Project Version Provider
A commitizen version provider for Xcode project files, which store the version in the MARKETING_VERSION
field.
Installation
pip install commitizen-xcodeproj
Usage
Configuration
There are several ways to configure commitizen.
This example setup uses a local installation of commitizen via python and works with yaml
configuration files, but any other format as stated in the commitizen documentation works as well.
In your Lightroom plug-in source folder, create a .cz.yaml
:
---
commitizen:
name: cz_conventional_commits
tag_format: $version
update_changelog_on_bump: true
version_provider: "commitizen-xcodeproj"
version_scheme: semver
Note: it's not necessary to include a version
key inside the config file. Best practice is to keep the version in a single source of truth, which is the project.pbxproj
file.
Bumping versions
Now
cz bump
will read the current version from project.pbxproj
, increase it accordingly and write it back to the same file to both, the Debug and the Release version.
Contribution
Contributions, issues and feature requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
- Fork the project
- Clone the fork
- Add your changes and update tests as appropriate.
- Create a pull request
License
This project is MIT licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for commitizen_xcodeproj-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d80c1406c70cb953a29e28d47616f466c89710689fd2055c8d69c412046333b5 |
|
MD5 | 12f4f82fb9c70a38e8249120db277a06 |
|
BLAKE2b-256 | cadcaa5c87a156597a48981ad484c74800746756b5eea966d88d479741835543 |
Hashes for commitizen_xcodeproj-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6406caa6e8a7cbb5352627e41bd68bc7d5c3f8c1891fc9df03c9a29fe9a8c41 |
|
MD5 | e7c8906339939c8ffe995bc4aae186fd |
|
BLAKE2b-256 | 673c506962f79d85fa03516144e4320e8b9ae096df18bd606bbc05a22eb7c7b7 |