How add api keys file for app directory

[IHIierO]

If you are looking for help, please confirm the following...

• I confirm I have searched the Docs, Codemagic Sample Projects, and GitHub Discussions.
• I confirm the software versions on my local computer match the ones in CI environment (e.g. Xcode version, Gradle version). See here
• I confirm I am able to do a fresh clone of the repository and build the project on my local computer.

Which mobile framework are you using?

iOS (Swift, Objective-C)

Steps to reproduce

I added a file with API keys to .gitignore so they wouldn't end up in my git. How do I recreate this file when building from the codemagic.yaml file?
workflows:
ios-workflow:
name: iOS Workflow
environment:
groups:
- app_store_credentials # <-- (APP_STORE_CONNECT_ISSUER_ID, APP_STORE_CONNECT_KEY_IDENTIFIER, APP_STORE_CONNECT_PRIVATE_KEY)
# APP_STORE_CONNECT_ISSUER_ID <-- Put your App Store Connect Issuer Id here
# APP_STORE_CONNECT_KEY_IDENTIFIER <-- Put your App Store Connect Key Identifier here
# APP_STORE_CONNECT_PRIVATE_KEY <-- Put your App Store Connect Private Key here
# See the following link for more details - https://docs.codemagic.io/code-signing-yaml/signing-ios/
# https://appstoreconnect.apple.com/access/api
# - certificate_credentials # <-- (CERTIFICATE_PRIVATE_KEY - Put your Certificate Private Key here) - app_store_credentials # <-- (APP_STORE_CONNECT_ISSUER_ID, APP_STORE_CONNECT_KEY_IDENTIFIER, APP_STORE_CONNECT_PRIVATE_KEY)
- apiKeys # <-- ApiKeys file <<<<HERE
vars:
XCODE_PROJECT: "AppName.xcodeproj" # <-- Put the name of your workspace here.
XCODE_SCHEME: "AppName" # <-- Put the name of your scheme here.
BUNDLE_ID: "com.example" # <-- Put your Bundle Id here.
APP_STORE_APP_ID: number # <-- Put the app id number here. This is found in App Store Connect > App > General > App Information
xcode: latest
scripts:
- name: Test echo
script: |
echo $APP_STORE_CONNECT_ISSUER_ID
echo $APP_STORE_CONNECT_KEY_IDENTIFIER
echo $APP_STORE_CONNECT_PRIVATE_KEY
echo $CERTIFICATE_PRIVATE_KEY
echo $apiKeys_json <<<<HERE
- name: Set up keychain to be used for codesigning using Codemagic CLI 'keychain' command
script: |
keychain initialize
- name: Fetch signing files
script: |
app-store-connect fetch-signing-files $BUNDLE_ID --type IOS_APP_STORE --create
- name: Use system default keychain
script: |
keychain add-certificates
- name: Set up code signing settings on Xcode project
script: |
xcode-project use-profiles
- name: Change Bundle ID for release
script: |
new_bundle_id=$BUNDLE_ID
project=$(ls | grep .xcodeproj)
old_bundle_id=$(awk -F '=' '/PRODUCT_BUNDLE_IDENTIFIER/ {print $2; exit}' ./"$project"/project.pbxproj)
old_bundle_id=${old_bundle_id:0:$((${#old_bundle_id} - 1))}
sed -i '' "s/${old_bundle_id}/${new_bundle_id}/g" ./"$project"/project.pbxproj
- name: Generate apiKeys.json file <<<<HERE
script: |
echo $apiKeys_json | base64 --decode > path/to/directory/APIKeys.json
- name: Build ipa for distribution
script: |
set -e
set -x
xcode-project use-profiles
xcode-project build-ipa
--project "$XCODE_PROJECT"
--scheme "$XCODE_SCHEME"
--archive-flags "-destination 'generic/platform=iOS'"
--archive-xcargs "CODE_SIGNING_REQUIRED=YES CODE_SIGNING_ALLOWED=NO"
artifacts:
- build/ios/ipa/.ipa
- /tmp/xcodebuild_logs/.log
- $HOME/Library/Developer/Xcode/DerivedData//Build//*.dSYM
publishing:
app_store_connect: # https://docs.codemagic.io/publishing-yaml/distribution
api_key: $APP_STORE_CONNECT_PRIVATE_KEY # Contents of the API key, can also reference environment variable such as $APP_STORE_CONNECT_PRIVATE_KEY
key_id: $APP_STORE_CONNECT_KEY_IDENTIFIER # Alphanumeric value that identifies the API key, can also reference environment variable such as $APP_STORE_CONNECT_KEY_IDENTIFIER
issuer_id: $APP_STORE_CONNECT_ISSUER_ID # Alphanumeric value that identifies who created the API key, can also reference environment variable such as $APP_STORE_CONNECT_ISSUER_ID
submit_to_testflight: false # Optional boolean, defaults to false. Whether or not to submit the uploaded build to TestFlight beta review. Required for distributing to beta groups. Note: This action is performed during post-processing.
# beta_groups: # Specify the names of beta tester groups that will get access to the build once it has passed beta review.
# - group name 1
# - group name 2

Expected results

The file was created.

Actual results

The file was not created.

Build id (optional)

No response

[himesh-cm]

Hi @IHIierO,

Here is a sample script you can add as part of your workflow. Please feel free to change them according to your requirements.

- name: Create API Key file
  script: |
    touch api_keys.env
    echo "$API_KEY1" >> api_keys.env
    echo "$API_KEY2" >> api_keys.env

Here API_KEY1 & API_KEY2 are the environment variables which you can add in your app settings > environment variables

From your yaml file, it is not clear why you want to decode.

Please share the use case in details, so i can better assist you.

[himesh-cm]

I'm tentatively closing the discussion since we haven't heard back from you. You can open the discussion again by replying to this message or opening a new discussion.