README.md

xcconfig plugin

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-xcconfig, add it to your project by running:

fastlane add_plugin xcconfig

About xcconfig

Adds 3 actions to fastlane to read and update xcconfig files.

Example

lane :test do

  # Read PRODUCT_BUNDLE_IDENTIFIER value from Configs/Release.xcconfig
  bundle_id = get_xcconfig_value(
    path: 'fastlane/Configs/Release.xcconfig',
    name: 'PRODUCT_BUNDLE_IDENTIFIER'
  )

  # Update PRODUCT_NAME value to 'Updated App' in Configs/Test.xcconfig
  # Will fail if PRODUCT_NAME doesn't exist in Configs/Test.xcconfig
  update_xcconfig_value(
    path: 'fastlane/Test.xcconfig',
    name: 'PRODUCT_NAME',
    value: 'Updated App'
  )

  # Updates the value and hides it from being printed to the UI.
  # Used to hide sensitive data from being displayed in logs.
  update_xcconfig_value(
    path: 'fastlane/Test.xcconfig',
    name: 'PRODUCT_NAME',
    value: 'Updated App Hidden',
    mask_value: true
  )

  # Sets PRODUCT_BUNDLE_IDENTIFIER value to 'com.sovcharenko.App-beta' in Configs/Release.xcconfig
  # PRODUCT_BUNDLE_IDENTIFIER will be added if it doesn't exist
  set_xcconfig_value(
    path: 'fastlane/Configs/Release.xcconfig',
    name: 'PRODUCT_BUNDLE_IDENTIFIER',
    value: 'com.sovcharenko.App-beta'
  )

  # Sets the value and hides it from printed to the UI.
  # Used to hide sensitive data from being displayed in logs.
  set_xcconfig_value(
    path: 'fastlane/Configs/Release.xcconfig',
    name: 'PRODUCT_BUNDLE_IDENTIFIER',
    value: 'com.sovcharenko.App-beta',
    mask_value: true
  )

end

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.