Skip to content

Commit dbdfb51

Browse files
committed
review: improve shell script variable quoting for better practices
Update shell script to use proper variable quoting syntax throughout (${VARIABLE} instead of $VARIABLE) for better shell scripting practices and consistency. This change was requested during code review to follow shell scripting best practices. While this won't cause problems in practice, it prevents potential word splitting issues and improves code maintainability.
1 parent 15b7c30 commit dbdfb51

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

.github/workflows/sdk-breaking-change-check.yml

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ jobs:
4848
run: |
4949
echo "🔍 Validating required client_payload fields..."
5050
51-
if [ -z "$SOURCE_REPO" ] || [ -z "$SDK_VERSION" ] || [ -z "$ARTIFACTS_RUN_ID" ] || [ -z "$ARTIFACT_NAME" ]; then
51+
if [ -z "${SOURCE_REPO}" ] || [ -z "${SDK_VERSION}" ] || [ -z "${ARTIFACTS_RUN_ID}" ] || [ -z "${ARTIFACT_NAME}" ]; then
5252
echo "::error::Missing required client_payload fields"
53-
echo "SOURCE_REPO: $SOURCE_REPO"
54-
echo "SDK_VERSION: $SDK_VERSION"
55-
echo "ARTIFACTS_RUN_ID: $ARTIFACTS_RUN_ID"
56-
echo "ARTIFACT_NAME: $ARTIFACT_NAME"
57-
echo "CLIENT_LABEL: $CLIENT_LABEL"
53+
echo "SOURCE_REPO: ${SOURCE_REPO}"
54+
echo "SDK_VERSION: ${SDK_VERSION}"
55+
echo "ARTIFACTS_RUN_ID: ${ARTIFACTS_RUN_ID}"
56+
echo "ARTIFACT_NAME: ${ARTIFACT_NAME}"
57+
echo "CLIENT_LABEL: ${CLIENT_LABEL}"
5858
exit 1
5959
fi
6060
@@ -83,37 +83,37 @@ jobs:
8383
8484
RETRY_COUNT=0
8585
MAX_RETRIES=3
86-
while [ $RETRY_COUNT -lt $MAX_RETRIES ]; do
86+
while [ ${RETRY_COUNT} -lt ${MAX_RETRIES} ]; do
8787
RETRY_COUNT=$((RETRY_COUNT + 1))
88-
echo "🔄 npm ci attempt $RETRY_COUNT of $MAX_RETRIES..."
88+
echo "🔄 npm ci attempt ${RETRY_COUNT} of ${MAX_RETRIES}..."
8989
9090
if npm ci; then
9191
echo "✅ npm ci successful"
9292
break
9393
else
94-
echo "❌ npm ci attempt $RETRY_COUNT failed"
95-
[ $RETRY_COUNT -lt $MAX_RETRIES ] && sleep 5
94+
echo "❌ npm ci attempt ${RETRY_COUNT} failed"
95+
[ ${RETRY_COUNT} -lt ${MAX_RETRIES} ] && sleep 5
9696
fi
9797
done
9898
99-
if [ $RETRY_COUNT -eq $MAX_RETRIES ] && ! npm ci; then
100-
echo "::error::npm ci failed after $MAX_RETRIES attempts"
99+
if [ ${RETRY_COUNT} -eq ${MAX_RETRIES} ] && ! npm ci; then
100+
echo "::error::npm ci failed after ${MAX_RETRIES} attempts"
101101
exit 1
102102
fi
103103
104104
- name: Download SDK artifacts
105105
env:
106106
GH_TOKEN: ${{ steps.app-token.outputs.token }}
107107
run: |
108-
echo "📥 Downloading SDK artifacts for $CLIENT_LABEL client from $SOURCE_REPO run $ARTIFACTS_RUN_ID..."
108+
echo "📥 Downloading SDK artifacts for ${CLIENT_LABEL} client from ${SOURCE_REPO} run ${ARTIFACTS_RUN_ID}..."
109109
110110
# Download SDK artifacts with error handling
111-
if ! gh run download $ARTIFACTS_RUN_ID \
112-
--repo $SOURCE_REPO \
113-
--name $ARTIFACT_NAME \
111+
if ! gh run download ${ARTIFACTS_RUN_ID} \
112+
--repo ${SOURCE_REPO} \
113+
--name ${ARTIFACT_NAME} \
114114
--dir ./temp-sdk-artifacts; then
115-
echo "::error::Failed to download SDK artifacts from run $ARTIFACTS_RUN_ID"
116-
echo "::error::Repository: $SOURCE_REPO, Artifact: $ARTIFACT_NAME"
115+
echo "::error::Failed to download SDK artifacts from run ${ARTIFACTS_RUN_ID}"
116+
echo "::error::Repository: ${SOURCE_REPO}, Artifact: ${ARTIFACT_NAME}"
117117
exit 1
118118
fi
119119
@@ -131,8 +131,8 @@ jobs:
131131
- name: Install SDK locally and run type check
132132
run: |
133133
echo "🔧 Installing SDK artifacts locally..."
134-
echo "📊 SDK Version: $SDK_VERSION"
135-
echo "📦 Artifact Source: $SOURCE_REPO run $ARTIFACTS_RUN_ID"
134+
echo "📊 SDK Version: ${SDK_VERSION}"
135+
echo "📦 Artifact Source: ${SOURCE_REPO} run ${ARTIFACTS_RUN_ID}"
136136
137137
# Create local package and install
138138
mkdir -p ./local-sdk-package
@@ -144,15 +144,15 @@ jobs:
144144
echo "🔗 Installing local SDK package..."
145145
npm install ./local-sdk-package
146146
147-
echo "🔍 Running TypeScript type checking for $CLIENT_LABEL client with SDK version: $SDK_VERSION"
147+
echo "🔍 Running TypeScript type checking for ${CLIENT_LABEL} client with SDK version: ${SDK_VERSION}"
148148
echo "🎯 Type checking command: npm run test:types"
149149
150150
# Add GitHub Step Summary output
151-
echo "## 📊 TypeScript Compatibility Check ($CLIENT_LABEL)" >> $GITHUB_STEP_SUMMARY
152-
echo "- **Client**: $CLIENT_LABEL" >> $GITHUB_STEP_SUMMARY
153-
echo "- **SDK Version**: $SDK_VERSION" >> $GITHUB_STEP_SUMMARY
154-
echo "- **Source Repository**: $SOURCE_REPO" >> $GITHUB_STEP_SUMMARY
155-
echo "- **Artifacts Run ID**: $ARTIFACTS_RUN_ID" >> $GITHUB_STEP_SUMMARY
151+
echo "## 📊 TypeScript Compatibility Check (${CLIENT_LABEL})" >> $GITHUB_STEP_SUMMARY
152+
echo "- **Client**: ${CLIENT_LABEL}" >> $GITHUB_STEP_SUMMARY
153+
echo "- **SDK Version**: ${SDK_VERSION}" >> $GITHUB_STEP_SUMMARY
154+
echo "- **Source Repository**: ${SOURCE_REPO}" >> $GITHUB_STEP_SUMMARY
155+
echo "- **Artifacts Run ID**: ${ARTIFACTS_RUN_ID}" >> $GITHUB_STEP_SUMMARY
156156
echo "" >> $GITHUB_STEP_SUMMARY
157157
158158
TYPE_CHECK_START=$(date +%s)
@@ -161,15 +161,15 @@ jobs:
161161
if timeout 10m npm run test:types; then
162162
TYPE_CHECK_END=$(date +%s)
163163
TYPE_CHECK_DURATION=$((TYPE_CHECK_END - TYPE_CHECK_START))
164-
echo "✅ TypeScript compilation successful for $CLIENT_LABEL client (${TYPE_CHECK_DURATION}s)"
164+
echo "✅ TypeScript compilation successful for ${CLIENT_LABEL} client (${TYPE_CHECK_DURATION}s)"
165165
echo "✅ **Result**: TypeScript compilation successful" >> $GITHUB_STEP_SUMMARY
166-
echo "No breaking changes detected in $CLIENT_LABEL client for SDK version $SDK_VERSION" >> $GITHUB_STEP_SUMMARY
166+
echo "No breaking changes detected in ${CLIENT_LABEL} client for SDK version ${SDK_VERSION}" >> $GITHUB_STEP_SUMMARY
167167
else
168168
TYPE_CHECK_END=$(date +%s)
169169
TYPE_CHECK_DURATION=$((TYPE_CHECK_END - TYPE_CHECK_START))
170-
echo "❌ TypeScript compilation failed for $CLIENT_LABEL client after ${TYPE_CHECK_DURATION}s - breaking changes detected"
170+
echo "❌ TypeScript compilation failed for ${CLIENT_LABEL} client after ${TYPE_CHECK_DURATION}s - breaking changes detected"
171171
echo "❌ **Result**: TypeScript compilation failed" >> $GITHUB_STEP_SUMMARY
172-
echo "Breaking changes detected in $CLIENT_LABEL client for SDK version $SDK_VERSION" >> $GITHUB_STEP_SUMMARY
172+
echo "Breaking changes detected in ${CLIENT_LABEL} client for SDK version ${SDK_VERSION}" >> $GITHUB_STEP_SUMMARY
173173
exit 1
174174
fi
175175

0 commit comments

Comments
 (0)