Skip to content

feat(sdk-python): replace verbatim release notes inheritance with --generate-notes #3835

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
wenshao merged 6 commits into from
May 8, 2026
Merged

feat(sdk-python): replace verbatim release notes inheritance with --generate-notes #3835

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0d72c8d
feat(sdk-python): replace verbatim release notes inheritance with --g…
doudouOUC May 4, 2026
fcd92b4
fix(sdk-python): address review comments on release notes
doudouOUC May 5, 2026
819d82f
fix(sdk-python): validate previous tag exists before using --notes-st…
doudouOUC May 5, 2026
cb23ae2
fix(sdk-python): clarify else-branch comment covers first stable + pr…
doudouOUC May 5, 2026
800d0c6
fix(sdk-python): use Bash array for gh release args to fix SC2086 lint
doudouOUC May 6, 2026
f6422b0
refactor(sdk-python): extract PREVIOUS_TAG_NAME to reduce repetition
doudouOUC May 7, 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
23 changes: 10 additions & 13 deletions .github/workflows/release-sdk-python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,28 +403,25 @@ jobs:
echo ""
} > "${NOTES_FILE}"

NOTES_START_TAG_ARG=""
GENERATE_NOTES_FLAG="--generate-notes"
if [[ -n "${PREVIOUS_RELEASE_TAG}" ]]; then
PREVIOUS_NOTES=$(gh release view "sdk-python-${PREVIOUS_RELEASE_TAG}" --json body -q '.body' 2>&1) || {
ERR_MSG="${PREVIOUS_NOTES}"
case "${ERR_MSG}" in
*"release not found"*|*"Not Found"*|*"HTTP 404"*)
PREVIOUS_NOTES='See commit history for changes.'
;;
*)
echo "::warning::Failed to fetch previous release notes: ${ERR_MSG}"
PREVIOUS_NOTES='See commit history for changes.'
;;
esac
}
printf '%s\n' "${PREVIOUS_NOTES}" >> "${NOTES_FILE}"
# --notes-start-tag replaces the old gh release view fetch;
# gh release create handles missing tags with a clear error.
NOTES_START_TAG_ARG="--notes-start-tag sdk-python-${PREVIOUS_RELEASE_TAG}"
Comment thread
doudouOUC marked this conversation as resolved.
Resolved
else
# PREVIOUS_RELEASE_TAG is only computed for stable releases.
# For preview/nightly, skip --generate-notes to avoid including non-SDK commits.
GENERATE_NOTES_FLAG=""
echo "See commit history for changes." >> "${NOTES_FILE}"
fi

gh release create "${TAG_NAME}" \
--target "${RELEASE_TARGET_SHA}" \
--title "SDK Python Release ${RELEASE_TAG}" \
--notes-file "${NOTES_FILE}" \
${GENERATE_NOTES_FLAG} \
${NOTES_START_TAG_ARG} \
${PRERELEASE_FLAG}

rm -f "${NOTES_FILE}"
Expand Down
Loading