Skip to content

Commit eeea754

Browse files
authored
Fix outdated (#3495)
* chore: update dependency versions * chore: rename GCLOUD_SERVICE_ACCOUNT_CREDENTIALS to GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS in documentation * chore: update documentation with latest dependency versions, device configurations, and environment defaults * docs: update macOS notarization to use notarytool and raise minimum iOS platform version to 13.0
1 parent 2974c31 commit eeea754

18 files changed

Lines changed: 70 additions & 67 deletions

content/integrations/appdome-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ workflows:
183183

184184
publishing:
185185
google_play:
186-
credentials: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS
186+
credentials: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS
187187
track: internal
188188
submit_as_draft: true
189189
email:

content/integrations/discord-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following is an example of how to perform a cURL request that uses your Disc
5252
{{< highlight bash "style=paraiso-dark">}}
5353

5454
curl -H "Content-Type: multipart/form-data" \
55-
-F 'payload_json={"username" : "codemagic-builds", "content": "**Commit:** `'"$COMMIT"'`\n\n**Commit message:** '"$COMMIT_MESSAGE"'\n\n**Branch:** '"$FCI_BRANCH"'\n\n**Author:** '"$AUTHOR"'\n\n**Artifacts: **\n\n'"$APP_LINK"'\n\n"}' \
55+
-F 'payload_json={"username" : "codemagic-builds", "content": "**Commit:** `'"$COMMIT"'`\n\n**Commit message:** '"$COMMIT_MESSAGE"'\n\n**Branch:** '"$CM_BRANCH"'\n\n**Author:** '"$AUTHOR"'\n\n**Artifacts: **\n\n'"$APP_LINK"'\n\n"}' \
5656
-F "file1=@release_notes.txt" \
5757
$WEBHOOK_URL
5858
{{< /highlight >}}

content/integrations/lambdatest-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ In order to see your tests being uploaded to the **App Automation**, tests need
8585
{{< highlight java "style=paraiso-dark">}}
8686
DesiredCapabilities capabilities = new DesiredCapabilities();
8787
capabilities.setCapability("platformName", "iOS");
88-
capabilities.setCapability("deviceName", "iPhone 10");
88+
capabilities.setCapability("deviceName", "iPhone 16");
8989
capabilities.setCapability("isRealMobile", true);
9090
capabilities.setCapability("platformVersion","10");
9191
capabilities.setCapability("app","lt://APP100202151634649275590734");

content/integrations/rock-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ workflows:
212212

213213
publishing:
214214
google_play:
215-
credentials: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS
215+
credentials: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS
216216
track: internal
217217
email:
218218
recipients:
@@ -427,7 +427,7 @@ Outputs are placed under `.rock/cache/ios/package/` (`.xcframework`) and `.rock/
427427
| `CM_KEY_PASSWORD` | auto (android_signing) | Android release | Key password |
428428
| `CERTIFICATE_PATH` | auto (ios_signing) | iOS release | Path to `.p12` on build machine |
429429
| `PROVISIONING_PROFILE_PATH` | auto (ios_signing) | iOS release | Path to `.mobileprovision` |
430-
| `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` | env group | Android publishing | Google Play service account JSON |
430+
| `GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS` | env group | Android publishing | Google Play service account JSON |
431431

432432
---
433433

content/integrations/sonarcloud-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ All of the other steps will be performed using scripts in your `codemagic.yaml`
160160
-project "$XCODE_PROJECT" \
161161
-scheme "$XCODE_SCHEME" \
162162
-sdk iphonesimulator \
163-
-destination 'platform=iOS Simulator,name=iPhone 12 Pro,OS=14.5' \
163+
-destination 'platform=iOS Simulator,name=iPhone 16 Pro' \
164164
-derivedDataPath Build/ \
165165
-enableCodeCoverage YES \
166166
clean build test CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO

content/knowledge-codemagic/caching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A great article on Unity caching can be found in [our blog](https://blog.codemag
2323

2424

2525
{{<notebox>}}
26-
**Note:** Caching `$HOME/Library/Developer/Xcode/DerivedData` won't help to speed up iOS builds with Xcode 10.2 or later.
26+
**Note:** Caching `$HOME/Library/Developer/Xcode/DerivedData` won't help to speed up iOS builds.
2727
{{</notebox>}}
2828

2929
## Enabling dependency caching

content/knowledge-others/import-variables-from-env-file.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ xxxx
2929
xxxx
3030
-----END RSA PRIVATE KEY-----'
3131

32-
GCLOUD_SERVICE_ACCOUNT_CREDENTIALS='{
32+
GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS='{
3333
"type": "service_account",
3434
"project_id": "xxxx",
3535
"private_key_id": "xxxx",
@@ -54,7 +54,7 @@ In your codemagic.yaml you’ll need to define the variables so you don’t get
5454
APP_STORE_CONNECT_KEY_IDENTIFIER: $APP_STORE_CONNECT_KEY_IDENTIFIER
5555
APP_STORE_CONNECT_ISSUER_ID: $APP_STORE_CONNECT_ISSUER_ID
5656
CERTIFICATE_PRIVATE_KEY: $CERTIFICATE_PRIVATE_KEY
57-
GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS
57+
GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS
5858
...
5959
{{< /highlight >}}
6060

@@ -64,7 +64,7 @@ In your codemagic.yaml you’ll need to define the variables so you don’t get
6464
**Note:** it is important that a valid service account is configured in the UI before overriding with another.
6565
{{</notebox>}}
6666

67-
In the Codemagic UI you should create an environment variable called `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` and set its value to a valid Service Account JSON, even if this will be overwritten by another key when white labelling.
67+
In the Codemagic UI you should create an environment variable called `GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS` and set its value to a valid Service Account JSON, even if this will be overwritten by another key when white labelling.
6868

6969
## Writing values to CM_ENV
7070

@@ -88,8 +88,8 @@ The following script first loads the **settings.env** file so you can read its v
8888
echo "$CERTIFICATE_PRIVATE_KEY" >> $CM_ENV
8989
echo "DELIMITER" >> $CM_ENV
9090

91-
echo "GCLOUD_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
92-
echo "$GCLOUD_SERVICE_ACCOUNT_CREDENTIALS" >> $CM_ENV
91+
echo "GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
92+
echo "$GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS" >> $CM_ENV
9393
echo "DELIMITER" >> $CM_ENV
9494
{{< /highlight >}}
9595

@@ -109,7 +109,7 @@ workflow-name:
109109
APP_STORE_CONNECT_KEY_IDENTIFIER: $APP_STORE_CONNECT_KEY_IDENTIFIER
110110
APP_STORE_CONNECT_ISSUER_ID: $APP_STORE_CONNECT_ISSUER_ID
111111
CERTIFICATE_PRIVATE_KEY: $CERTIFICATE_PRIVATE_KEY
112-
GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS
112+
GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS
113113
...
114114

115115

@@ -130,8 +130,8 @@ workflow-name:
130130
echo "$CERTIFICATE_PRIVATE_KEY" >> $CM_ENV
131131
echo "DELIMITER" >> $CM_ENV
132132

133-
echo "GCLOUD_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
134-
echo "$GCLOUD_SERVICE_ACCOUNT_CREDENTIALS" >> $CM_ENV
133+
echo "GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
134+
echo "$GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS" >> $CM_ENV
135135
echo "DELIMITER" >> $CM_ENV
136136
...
137137
publishing:
@@ -140,7 +140,7 @@ workflow-name:
140140
key_id: $APP_STORE_CONNECT_KEY_IDENTIFIER
141141
issuer_id: $APP_STORE_CONNECT_ISSUER_ID
142142
google_play:
143-
credentials: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER
143+
credentials: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER
144144
track: $GOOGLE_PLAY_TRACK
145145
in_app_update_priority: 0
146146
{{< /highlight >}}

content/knowledge-others/import-variables-from-secret-manager.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ aws secretsmanager get-secret-value \
8080
{{< tab header="Android" >}}
8181
{{<markdown>}}
8282

83-
1. The environment variable `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` must be provided with a valid Service Account JSON key, even if you will overwrite it with a different key later. Add this variable to a group called `service_account` and then import it into you workflow as follows:
83+
1. The environment variable `GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS` must be provided with a valid Service Account JSON key, even if you will overwrite it with a different key later. Add this variable to a group called `service_account` and then import it into you workflow as follows:
8484

8585
{{< highlight yaml "style=paraiso-dark">}}
8686
environment:
8787
groups:
8888
- service_account
8989
- aws_credentials
9090
vars:
91-
GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS
91+
GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS
9292
{{< /highlight >}}
9393

9494
2. In your first script step, retrieve the Service Account JSON from AWS and add it to **CM_ENV**.
@@ -97,9 +97,9 @@ aws secretsmanager get-secret-value \
9797
scripts:
9898
- name: Set Service Account JSON from AWS
9999
script: |
100-
echo "GCLOUD_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
100+
echo "GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
101101
echo "$(aws secretsmanager get-secret-value \
102-
--secret-id GCLOUD_SERVICE_ACCOUNT_CREDENTIALS | jq -r '.SecretString')" >> $CM_ENV
102+
--secret-id GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS | jq -r '.SecretString')" >> $CM_ENV
103103
echo "DELIMITER" >> $CM_ENV
104104
{{< /highlight >}}
105105

@@ -108,7 +108,7 @@ aws secretsmanager get-secret-value \
108108
{{< highlight yaml "style=paraiso-dark">}}
109109
publishing:
110110
google_play:
111-
credentials: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER
111+
credentials: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER
112112
track: $GOOGLE_PLAY_TRACK
113113
{{< /highlight >}}
114114

@@ -260,16 +260,16 @@ The following example shows how to retrieve a secret called `APP_STORE_CONNECT_I
260260
echo "APP_STORE_CONNECT_ISSUER_ID=$(doppler secrets get APP_STORE_CONNECT_ISSUER_ID --plain)" >> $CM_ENV
261261
{{< /highlight >}}
262262

263-
If you want to retrieve a secret with multiline variable, like the `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` you can do it like this:
263+
If you want to retrieve a secret with multiline variable, like the `GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS` you can do it like this:
264264

265265
{{< highlight bash "style=paraiso-dark">}}
266-
echo "GCLOUD_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
267-
echo "$(doppler secrets get GCLOUD_SERVICE_ACCOUNT_CREDENTIALS --plain)" >> $CM_ENV
266+
echo "GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
267+
echo "$(doppler secrets get GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS --plain)" >> $CM_ENV
268268
echo "DELIMITER" >> $CM_ENV
269269
{{< /highlight >}}
270270

271271
{{<notebox>}}
272-
**Note:** If you add the `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` make sure you choose **No** when it asks you to replace `\n` with new lines.
272+
**Note:** If you add the `GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS` make sure you choose **No** when it asks you to replace `\n` with new lines.
273273
{{</notebox>}}
274274

275275
You can download all of your secrets and add them to your environment in a single step.
@@ -359,13 +359,13 @@ vault kv get -field=message secret/greetings
359359
To add a secret from file such as an RSA key or JSON key, you can add the contents of a file as follows:
360360

361361
{{< highlight bash "style=paraiso-dark">}}
362-
vault kv put secret/gcloud GCLOUD_SERVICE_ACCOUNT_CREDENTIALS=@gcloud.json
362+
vault kv put secret/gcloud GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS=@gcloud.json
363363
{{< /highlight >}}
364364

365365
To retrieve the secret you would do the following:
366366

367367
{{< highlight bash "style=paraiso-dark">}}
368-
vault kv get -field=GCLOUD_SERVICE_ACCOUNT_CREDENTIALS secret/gcloud
368+
vault kv get -field=GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS secret/gcloud
369369
{{< /highlight >}}
370370

371371

@@ -383,13 +383,13 @@ vault kv get -field=message secret/greetings
383383
{{< tab header="Android" >}}
384384
{{<markdown>}}
385385

386-
1. The environment variable `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` must be provided with a valid Service Account JSON key, even if you will overwrite it with a different key later. Add this variable to a group called `service_account` and then import it into you workflow.
386+
1. The environment variable `GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS` must be provided with a valid Service Account JSON key, even if you will overwrite it with a different key later. Add this variable to a group called `service_account` and then import it into you workflow.
387387

388388
2. Add the secret for your **Google Console Service Account** to Hashicorp Vault as follows:
389389

390390
{{< highlight bash "style=paraiso-dark">}}
391391
vault kv put secret/google \\
392-
GCLOUD_SERVICE_ACCOUNT_CREDENTIALS=@/path/to/service_account.json
392+
GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS=@/path/to/service_account.json
393393
{{< /highlight >}}
394394

395395
3. Add the following environment variables and groups in your `codemagic.yaml`
@@ -400,7 +400,7 @@ GCLOUD_SERVICE_ACCOUNT_CREDENTIALS=@/path/to/service_account.json
400400
- service_account
401401
- vault_credentials
402402
vars:
403-
GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS
403+
GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS
404404
{{< /highlight >}}
405405

406406
4. In your first script step, retrieve the Service Account JSON from Hashicorp Vault and add it to *CM_ENV*.
@@ -409,8 +409,8 @@ GCLOUD_SERVICE_ACCOUNT_CREDENTIALS=@/path/to/service_account.json
409409
scripts:
410410
- name: Set Service Account JSON from Hashicorp Vault
411411
script: |
412-
echo "GCLOUD_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
413-
echo "$(vault kv get -field=GCLOUD_SERVICE_ACCOUNT_CREDENTIALS secret/google)" >> $CM_ENV
412+
echo "GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS<<DELIMITER" >> $CM_ENV
413+
echo "$(vault kv get -field=GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS secret/google)" >> $CM_ENV
414414
echo "DELIMITER" >> $CM_ENV
415415
{{< /highlight >}}
416416

@@ -420,7 +420,7 @@ GCLOUD_SERVICE_ACCOUNT_CREDENTIALS=@/path/to/service_account.json
420420
{{< highlight yaml "style=paraiso-dark">}}
421421
publishing:
422422
google_play:
423-
credentials: $GCLOUD_SERVICE_ACCOUNT_CREDENTIALS_HOLDER
423+
credentials: $GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS_HOLDER
424424
track: $GOOGLE_PLAY_TRACK
425425
{{< /highlight >}}
426426

content/partials/code-signing-macos.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,11 @@ To package your application into an `.pkg` Installer package and sign it with th
276276

277277
Notarization is a process where Apple verifies your application to make sure it has a Developer ID code signature and does not contain malicious content. All apps distributed outside the Mac App Store have to be notarized.
278278

279-
Notarizing an app during the Codemagic build process is possible using the **altool** command as follows:
279+
Notarizing an app during the Codemagic build process is possible using the **notarytool** command as follows:
280280

281281
{{< highlight bash "style=paraiso-dark">}}
282-
xcrun altool --notarize-app -f <file> --primary-bundle-id <bundle_id>
283-
{-u <username> [-p <password>] | --apiKey <api_key> --apiIssuer <issuer_id>}
284-
[--asc-provider <name> | --team-id <id> | --asc-public-id <id>]
282+
xcrun notarytool submit <file> \
283+
--apple-id <username> --password <app_specific_password> --team-id <team_id> \
284+
--wait
285+
xcrun stapler staple <file>
285286
{{< /highlight >}}

content/partials/quickstart/code-signing-macos.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,11 @@ To package your application into an `.pkg` Installer package and sign it with th
164164

165165
Notarization is a process where Apple verifies your application to make sure it has a Developer ID code signature and does not contain malicious content. All apps distributed outside the Mac App Store have to be notarized.
166166

167-
Notarizing an app during the Codemagic build process is possible using the **altool** command as follows:
167+
Notarizing an app during the Codemagic build process is possible using the **notarytool** command as follows:
168168

169169
{{< highlight bash "style=paraiso-dark">}}
170-
xcrun altool --notarize-app -f <file> --primary-bundle-id <bundle_id>
171-
{-u <username> [-p <password>] | --apiKey <api_key> --apiIssuer <issuer_id>}
172-
[--asc-provider <name> | --team-id <id> | --asc-public-id <id>]
170+
xcrun notarytool submit <file> \
171+
--apple-id <username> --password <app_specific_password> --team-id <team_id> \
172+
--wait
173+
xcrun stapler staple <file>
173174
{{< /highlight >}}

0 commit comments

Comments
 (0)