set_changelog
Set the changelog for all languages on App Store Connect
This is useful if you have only one changelog for all languages.
You can store the changelog in./fastlane/changelog.txt
and it will automatically get loaded from there. This integration is useful if you support e.g. 10 languages and want to use the same "What's new"-text for all languages.
Defining the version is optional. fastlane will try to automatically detect it if you don't provide one.
set_changelog | |
---|---|
Supported platforms | ios, mac |
Author | @KrauseFx |
2 Examples
set_changelog(changelog: "Changelog for all Languages")
set_changelog(app_identifier: "com.krausefx.app", version: "1.0", changelog: "Changelog for all Languages")
Parameters
Key | Description | Default |
---|---|---|
api_key_path |
Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | |
api_key |
Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-hash-option) | * |
app_identifier |
The bundle identifier of your app | * |
username |
Your Apple ID Username | * |
version |
The version number to create/update | |
changelog |
Changelog text that should be uploaded to App Store Connect | |
team_id |
The ID of your App Store Connect team if you're in multiple teams | * |
team_name |
The name of your App Store Connect team if you're in multiple teams | * |
platform |
The platform of the app (ios, appletvos, mac) | ios |
* = default value is dependent on the user's system
Documentation
To show the documentation in your terminal, run
fastlane action set_changelog
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 set_changelog
To pass parameters, make use of the :
symbol, for example
fastlane run set_changelog 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