Skip to content

Add typeshed diff link to changelog during release #2957

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
AlexWaygood merged 2 commits into from
Mar 4, 2026
Merged

Add typeshed diff link to changelog during release #2957

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8246f64
Automate typeshed diff link in changelog during release
claude Mar 4, 2026
84db4b9
Use temp file instead of `sed -i` for macOS portability
claude Mar 4, 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: 23 additions & 0 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ case "${ruff_head}" in
esac


# Save the current typeshed source commit before updating ruff,
# so we can generate a typeshed diff link for the changelog later.
typeshed_commit_file="ruff/crates/ty_vendored/vendor/typeshed/source_commit.txt"
old_typeshed_commit=""
if [ -f "$typeshed_commit_file" ]; then
old_typeshed_commit=$(cat "$typeshed_commit_file")
fi

echo "Updating Ruff to the latest commit..."
git -C ruff pull origin main
git add ruff
Expand All @@ -46,5 +54,20 @@ cd "$project_root"
uv run --isolated --only-group release \
rooster release "$@"

# If the typeshed source commit changed and the changelog mentions a typeshed
# sync, append a link to the typeshed diff so reviewers can see what changed.
if [ -n "$old_typeshed_commit" ] && [ -f "$typeshed_commit_file" ]; then
new_typeshed_commit=$(cat "$typeshed_commit_file")
if [ "$old_typeshed_commit" != "$new_typeshed_commit" ]; then
typeshed_diff_link="[Typeshed diff](https://github.com/python/typeshed/compare/${old_typeshed_commit}...${new_typeshed_commit})"
# Match lines like "- Sync vendored typeshed stubs ([#NNNN](...))".
# The pattern anchors on the trailing "))$" so it won't match lines
# that already have a typeshed diff link appended.
# Use a temp file instead of `sed -i` for macOS/Linux portability.
sed "s|\(- Sync vendored typeshed stubs (.*)\))$|\1). ${typeshed_diff_link}|" CHANGELOG.md > CHANGELOG.md.tmp
mv CHANGELOG.md.tmp CHANGELOG.md
fi
fi

"${script_root}/autogenerate_files.sh"
git add ./docs/reference