Skip to content

Commit 0c36248

Browse files
ncreatedncreated
authored
Merge pull request #1962 from DataDog/ncreated/RUM-5344/avoid-rate-limiting-carthage-bootstrap
RUM-5344 chore: Export GH token to avoid rate limiting `carthage` in CI
2 parents 56c6da6 + fb91ae7 commit 0c36248

File tree

7 files changed

+47
-18
lines changed

7 files changed

+47
-18
lines changed

‎.gitlab-ci.yml

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ default:
4343
paths:
4444
- "Datadog*/**/*"
4545
- "IntegrationTests/**/*"
46+
- "SmokeTests/**/*"
4647
- "TestUtilities/**/*"
4748
- "*" # match any file in the root directory
4849
compare_to: 'develop' # cannot use $DEVELOP_BRANCH var due to: https://gitlab.com/gitlab-org/gitlab/-/issues/369916
@@ -237,6 +238,9 @@ Smoke Tests (macOS):
237238

238239
Smoke Tests (watchOS):
239240
stage: smoke-test
241+
rules:
242+
- !reference [.test-pipeline-job, rules]
243+
- !reference [.release-pipeline-job, rules]
240244
tags:
241245
- macos:ventura
242246
- specific:true

‎SmokeTests/carthage/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ ifeq ($(CARTHAGE_PLATFORM),)
4646
@exit 1
4747
endif
4848
@$(ECHO_INFO) "Using CARTHAGE_PLATFORM='$(CARTHAGE_PLATFORM)'"
49-
carthage update --platform $(CARTHAGE_PLATFORM) --use-xcframeworks
49+
REPO_ROOT=$(REPO_ROOT) $(REPO_ROOT)/tools/carthage-shim.sh update --platform $(CARTHAGE_PLATFORM) --use-xcframeworks
5050

5151
test:
5252
@$(call require_param,OS)

‎tools/carthage-shim.sh

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/bin/zsh
2+
3+
# Usage:
4+
# - in repo root:
5+
# $ ./tools/carthage-shim.sh [carthage commands and parameters]
6+
# - in different directory:
7+
# $ REPO_ROOT="../../" ../../tools/carthage-shim.sh [carthage commands and parameters]
8+
#
9+
# Shims Carthage commands with avoiding rate-limiting on CI.
10+
11+
source "${REPO_ROOT:-.}/tools/secrets/get-secret.sh"
12+
13+
# "In shared environment where several virtual machines are using the same public ip address (like CI),
14+
# carthage user could hit a Github API rate limit. By providing a Github API access token, carthage can get
15+
# a higher rate limit."
16+
# Ref.: https://github.com/Carthage/Carthage/pull/605
17+
if [ "$CI" = "true" ]; then
18+
export GITHUB_ACCESS_TOKEN=$(get_secret $DD_IOS_SECRET__CARTHAGE_GH_TOKEN)
19+
fi
20+
21+
carthage "$@"

‎tools/release/build-xcframeworks.sh

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ parse_args "$@"
2525

2626

2727
REPO_PATH=$(realpath "$repo_path")
28+
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
2829

2930
echo_info "Clean '$REPO_PATH' with 'git clean -fxd'"
3031
cd "$REPO_PATH" && git clean -fxd && cd -
@@ -107,7 +108,8 @@ echo_info "▸ PLATFORMS = '$PLATFORMS'"
107108

108109
# Build third-party XCFrameworks
109110
echo_subtitle2 "Run 'carthage bootstrap --platform $PLATFORMS --use-xcframeworks'"
110-
carthage bootstrap --platform $PLATFORMS --use-xcframeworks
111+
export REPO_ROOT=$(realpath "$SCRIPT_DIR/../..")
112+
$REPO_ROOT/tools/carthage-shim.sh bootstrap --platform $PLATFORMS --use-xcframeworks
111113
cp -r "Carthage/Build/CrashReporter.xcframework" "$XCFRAMEWORKS_OUTPUT"
112114
cp -r "Carthage/Build/OpenTelemetryApi.xcframework" "$XCFRAMEWORKS_OUTPUT"
113115

‎tools/repo-setup/repo-setup.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ if [[ "$env" == "$ENV_DEV" ]]; then
3434
fi
3535

3636
bundle install
37-
carthage bootstrap --platform iOS,tvOS --use-xcframeworks
37+
./tools/carthage-shim.sh bootstrap --platform iOS,tvOS --use-xcframeworks
3838

3939
echo_succ "Using OpenTelemetryApi version: $(cat ./Carthage/Build/.OpenTelemetryApi.version | grep 'commitish' | awk -F'"' '{print $4}')"
4040
echo_succ "Using PLCrashReporter version: $(cat ./Carthage/Build/.plcrashreporter.version | grep 'commitish' | awk -F'"' '{print $4}')"

‎tools/secrets/config.sh

+15-13
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ DD_IOS_SECRETS_PATH_PREFIX='kv/aws/arn:aws:iam::486234852809:role/ci-dd-sdk-ios/
1313
# Keep this list and Confluence page up-to-date with every secret that is added to the list.
1414
DD_IOS_SECRET__TEST_SECRET="test.secret"
1515
DD_IOS_SECRET__GH_CLI_TOKEN="gh.cli.token"
16+
DD_IOS_SECRET__CARTHAGE_GH_TOKEN="carthage.gh.token"
1617
DD_IOS_SECRET__CP_TRUNK_TOKEN="cocoapods.trunk.token"
1718
DD_IOS_SECRET__SSH_KEY="ssh.key"
1819
DD_IOS_SECRET__E2E_CERTIFICATE_P12_BASE64="e2e.certificate.p12.base64"
@@ -23,16 +24,17 @@ DD_IOS_SECRET__E2E_S8S_API_KEY="e2e.s8s.api.key"
2324
DD_IOS_SECRET__E2E_S8S_APP_KEY="e2e.s8s.app.key"
2425
DD_IOS_SECRET__E2E_S8S_APPLICATION_ID="e2e.s8s.app.id"
2526

26-
declare -A DD_IOS_SECRETS=(
27-
[0]="$DD_IOS_SECRET__TEST_SECRET | test secret to see if things work, free to change but not delete"
28-
[1]="$DD_IOS_SECRET__GH_CLI_TOKEN | GitHub token to authenticate 'gh' cli (https://cli.github.com/)"
29-
[2]="$DD_IOS_SECRET__CP_TRUNK_TOKEN | Cocoapods token to authenticate 'pod trunk' operations (https://guides.cocoapods.org/terminal/commands.html)"
30-
[3]="$DD_IOS_SECRET__SSH_KEY | SSH key to authenticate 'git clone git@github.com:...' operations"
31-
[4]="$DD_IOS_SECRET__E2E_CERTIFICATE_P12_BASE64 | Base64-encoded '.p12' certificate file for signing E2E app"
32-
[5]="$DD_IOS_SECRET__E2E_CERTIFICATE_P12_PASSWORD | Password to '$DD_IOS_SECRET__E2E_CERTIFICATE_P12_BASE64' certificate"
33-
[6]="$DD_IOS_SECRET__E2E_PROVISIONING_PROFILE_BASE64 | Base64-encoded provisioning profile file for signing E2E app"
34-
[7]="$DD_IOS_SECRET__E2E_XCCONFIG_BASE64 | Base64-encoded xcconfig file for E2E app"
35-
[8]="$DD_IOS_SECRET__E2E_S8S_API_KEY | DATADOG_API_KEY for uploading E2E app to synthetics"
36-
[9]="$DD_IOS_SECRET__E2E_S8S_APP_KEY | DATADOG_APP_KEY for uploading E2E app to synthetics"
37-
[10]="$DD_IOS_SECRET__E2E_S8S_APPLICATION_ID | Synthetics app ID for E2E tests"
38-
)
27+
idx=0
28+
declare -A DD_IOS_SECRETS
29+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__TEST_SECRET | test secret to see if things work, free to change but not delete"
30+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__GH_CLI_TOKEN | GitHub token to authenticate 'gh' cli (https://cli.github.com/)"
31+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__CARTHAGE_GH_TOKEN | GitHub token to avoid rate limiting Carthage commands (https://github.com/Carthage/Carthage/pull/605)"
32+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__CP_TRUNK_TOKEN | Cocoapods token to authenticate 'pod trunk' operations (https://guides.cocoapods.org/terminal/commands.html)"
33+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__SSH_KEY | SSH key to authenticate 'git clone git@github.com:...' operations"
34+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_CERTIFICATE_P12_BASE64 | Base64-encoded '.p12' certificate file for signing E2E app"
35+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_CERTIFICATE_P12_PASSWORD | Password to '$DD_IOS_SECRET__E2E_CERTIFICATE_P12_BASE64' certificate"
36+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_PROVISIONING_PROFILE_BASE64 | Base64-encoded provisioning profile file for signing E2E app"
37+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_XCCONFIG_BASE64 | Base64-encoded xcconfig file for E2E app"
38+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_S8S_API_KEY | DATADOG_API_KEY for uploading E2E app to synthetics"
39+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_S8S_APP_KEY | DATADOG_APP_KEY for uploading E2E app to synthetics"
40+
DD_IOS_SECRETS[$((idx++))]="$DD_IOS_SECRET__E2E_S8S_APPLICATION_ID | Synthetics app ID for E2E tests"

‎tools/secrets/get-secret.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/zsh
22

3-
source ./tools/utils/echo-color.sh
4-
source ./tools/secrets/config.sh
3+
source "${REPO_ROOT:-.}/tools/utils/echo-color.sh"
4+
source "${REPO_ROOT:-.}/tools/secrets/config.sh"
55

66
# Usage:
77
# get_secret <secret_name>

0 commit comments

Comments
 (0)