Skip to content

feat(ci) add OAS commit hash per service to generated SDKs #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cgoetz-inovex merged 3 commits into from
Jan 30, 2026
Merged

feat(ci) add OAS commit hash per service to generated SDKs #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
87f709c
feat(ci) add OAS commit hash per service to generated SDKs
cgoetz-inovex Jan 29, 2026
6c58717
fix(ci) copy oas_commit file from backup to service folder
cgoetz-inovex Jan 30, 2026
b2f4e7a
fix(ci) also copy oas_commit for java and python
cgoetz-inovex Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions scripts/download-oas.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ EOF
fi
cd ${work_dir}/${OAS_REPO_NAME} >/dev/null
git checkout -q $apiVersion || (echo "version ${apiVersion} does not exist, using main instead" && git checkout -q main)
echo "$service=$(git rev-parse HEAD)" >> oas_commits
cd - >/dev/null

# Prioritize GA over Beta over Alpha versions
Expand Down Expand Up @@ -121,3 +122,4 @@ EOF
fi
mv -f ${max_version_dir}/*.json ${ROOT_DIR}/oas
done
mv -f ${work_dir}/${OAS_REPO_NAME}/oas_commits ${ROOT_DIR}/oas/oas_commits
6 changes: 6 additions & 0 deletions scripts/generate-sdk/languages/go.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,12 @@ generate_go_sdk() {
cp -r "${sdk_services_backup_dir}/${service}/VERSION" "${SERVICES_FOLDER}/${service}/VERSION"
fi

# If the service has oas_commit file, move it inside the service folder
if [ -f "${sdk_services_backup_dir}/${service}/oas_commit" ]; then
echo "Found ${service} \"oas_commit\" file"
cp -r "${sdk_services_backup_dir}/${service}/oas_commit" "${SERVICES_FOLDER}/${service}/oas_commit"
fi

cd "${SERVICES_FOLDER}/${service}"
go work use .
# Make sure that dependencies are uptodate
Expand Down
6 changes: 6 additions & 0 deletions scripts/generate-sdk/languages/java.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,12 @@ generate_java_sdk() {
cp -r "${sdk_services_backup_dir}/${service}/VERSION" "${SERVICES_FOLDER}/${service}/VERSION"
fi

# If the service has oas_commit file, move it inside the service folder
if [ -f "${sdk_services_backup_dir}/${service}/oas_commit" ]; then
echo "Found ${service} \"oas_commit\" file"
cp -r "${sdk_services_backup_dir}/${service}/oas_commit" "${SERVICES_FOLDER}/${service}/oas_commit"
fi

done

cd "${SDK_REPO_LOCAL_PATH}"
Expand Down
6 changes: 6 additions & 0 deletions scripts/generate-sdk/languages/python.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,12 @@ generate_python_sdk() {
cp -r "${sdk_services_backup_dir}/${service}/NOTICE.txt" "${SERVICES_FOLDER}/${service}/NOTICE.txt"
fi

# If the service has oas_commit file, move it inside the service folder
if [ -f "${sdk_services_backup_dir}/${service}/oas_commit" ]; then
echo "Found ${service} \"oas_commit\" file"
cp -r "${sdk_services_backup_dir}/${service}/oas_commit" "${SERVICES_FOLDER}/${service}/oas_commit"
fi

cd "${SERVICES_FOLDER}/${service}"
# Run formatter
isort .
Expand Down
13 changes: 12 additions & 1 deletion scripts/sdk-create-pr.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,17 @@ for service_path in ${work_dir}/sdk_to_push/services/*; do
fi
fi

# write OAS commit hash of service into source tree, create compare link
old_commit=$(cat "services/${service}/oas_commit")
new_commit=$(grep "${service}=" "${ROOT_DIR}/oas/oas_commits" | cut -d = -f 2)
compare_link=""
if [[ -n "${old_commit}" ]] && [[ -n "${new_commit}" ]]; then
compare_link=https://github.com/stackitcloud/stackit-api-specifications/compare/${old_commit}...${new_commit}
fi
if [[ -n "${new_commit}" ]]; then
echo "${new_commit}" > "services/${service}/oas_commit"
fi

git add "services/${service}/"
if [ "${LANGUAGE}" == "go" ] && [ ! -d "${work_dir}/sdk_backup/services/${service}/" ]; then # Check if it is a newly added SDK module
git add go.work
Expand All @@ -128,7 +139,7 @@ for service_path in ${work_dir}/sdk_to_push/services/*; do
echo ">> Creating PR for $service"
git commit -m "Generate $service"
git push origin "$branch"
gh pr create --title "Generator: Update SDK /services/$service" --body "$COMMIT_INFO" --head "$branch" --base "main"
echo -e "$COMMIT_INFO\nspec comparison: ${compare_link}" | gh pr create --title "Generator: Update SDK /services/$service" --body-file - --head "$branch" --base "main"
else
echo ">> Pushing changes for $service service..."
git commit -m "Generate $service: $COMMIT_INFO"
Expand Down
Loading