diff --git a/CHANGELOG.md b/CHANGELOG.md index 264ac02ed..edb5a45d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,6 @@ ### Breaking Changes -- Remove the `skip_glotpress` parameter from the `ios_bump_version_release` action [#443] - Add the `public_version_xcconfig_file` parameter to the `ios_get_app_version` action to replace the need for an environment variable [#445] - Remove the `ios_localize_project` and `ios_update_metadata` actions [#447] - Remove the `skip_deliver` parameter from `ios_bump_version_hotfix` and `ios_bump_version_release` actions [#450] diff --git a/MIGRATION.md b/MIGRATION.md index e4282244e..7199d8ece 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -1,7 +1,25 @@ # Migration Instructions for Major Releases -### From `7.0.0` to `8.0.0` +## From `8.0.0` to `9.0.0` + +- The deprecated actions `ios_localize_project` and `ios_update_metadata` were now completely removed. If your project is still using them, please use the new tooling instead. + - See `ios_generate_strings_file_from_code`, `ios_extract_keys_from_strings_files`, `ios_download_strings_files_from_glotpress` and `ios_merge_strings_files` for typical replacements. +- The action `ios_get_app_version` now requires a parameter `public_version_xcconfig_file` with the public `.xcconfig` file path instead of relying on the environment variable `PUBLIC_CONFIG_FILE`. While the complete removal of this environment variable is our goal, at this point it is still required by other actions such as `ios_bump_version_release` and `ios_codefreeze_prechecks`. +- The usage of a `Deliverfile` (including its `app_version`) is discouraged -- please use `upload_to_app_store` directly from your `Fastfile` instead. Therefore, the parameter `skip_deliver` from the actions `ios_bump_version_hotfix` and `ios_bump_version_release` has been removed. + +### Clean-ups + +- You can now delete the `ENV['APP_STORE_STRINGS_FILE_NAME']` from your Fastfile, as it isn't being used anymore. + +## From `7.0.0` to `8.0.0` We are no longer pushing to remote after creating a new commit or a branch. That means, developers need to manually push the changes or add push commands in the project's `Fastfile`. Most importantly, we can no longer immediately trigger beta/final builds after creating a new commit because the changes will not be in remote yet. If you want to keep the existing behavior, you'll need to add a push command before these triggers. For example, in [WordPress-Android's `new_beta_release` lane](https://github.com/wordpress-mobile/WordPress-Android/blob/0c64cb84c256e004473e97d72b4ac6682ebc140b/fastlane/lanes/release.rb#L86), we download translations, bump the beta version and then trigger a new build in CI. After migrating to `8.0.0` of `release-toolkit`, we'll need to add [`push_to_git_remote`](https://docs.fastlane.tools/actions/push_to_git_remote/) command before this trigger to keep the existing behavior. + +## From `6.0.0` to `7.0.0` + +Ensure that calls to `ios_bump_version_release` already passed `skip_glotpress: true`. +In case of passing false as parameter or not providing a value (false being the default for this ConfigItem), you'll have to ensure that: +- `download_metadata.swift` isn't being used; if it is, it's a good time to migrate to the new tooling +- You're not relying on `ios_bump_version_release` for commiting the `.po/.pot` file