[SC-10335] Repo Sync repo-sync/21399 (2025-05-29)

[eggshell]

Repo Sync repo-sync/21399 (2025-05-29

[github-actions]

PR Summary

This PR introduces several improvements across the GitHub configuration and automation scripts to enhance the PR review and release process:

1. Pull Request Template Updates: The PR template has been refined for clarity and comprehensiveness. The changes include merging the 'What' and 'Why' sections into a combined description, renaming sections (e.g., 'How to Test' and 'What needs special review'), and adding a new checklist item for documenting environment variable changes. Redundant sections and formatting have been removed to streamline the review process.

2. Release Notes Check Script Enhancements: In the release notes check script, a timeout has been added to the requests call to avoid hanging requests. The script now also checks for an additional label ('dependencies') in addition to 'internal'. Consistency in string quoting and error messaging has been improved. These changes help ensure that pull requests include the necessary release notes or appropriate labels before they proceed.

3. AI Explain Workflow Improvements: The workflow script for AI-based explanations has been updated to:

   • Include a unique comment marker to reliably identify and delete previous bot comments.
   • Update the model configuration from an older model to a new one (switching from "gpt-4o" to "o3-mini") and implement improved error handling for external API calls (catching API connection errors, OpenAI errors, and generic exceptions).
   • Update dependencies by removing the now-unnecessary token estimation library (tiktoken) and by using a more recent version of the Python setup action.

4. Workflow and Permissions Updates: The GitHub Actions YAML files have been updated to use a newer Python version (3.11) and reflect changes in secret environment variable names (e.g., switching to OPENAI_PR_SUMMARY_KEY). Additionally, the permission for pull-request operations has been tightened from write to read in the release notes check workflow, aligning the permissions with their actual needs.

Test Suggestions

• Test the updated PR template by creating a pull request and verifying that the new sections and checklist items are rendered as expected.
• Simulate PR submissions with and without the necessary labels and release notes to ensure the release_notes_check.py script correctly comments on and rejects incomplete PRs.
• Run the AI explain workflow to verify that it correctly handles OpenAI API errors, deletes previous bot comments, and posts the new explanation with the unique marker.
• Validate that the workflow YAML files execute correctly on GitHub Actions, particularly verifying the Python version upgrade and proper handling of environment variables.