[SC-10335] Repo Sync repo-sync/24662 (2025-05-13)

[nibalizer]

Repo Sync repo-sync/24662 (2025-05-13

[github-actions]

PR Summary

This PR introduces several functional improvements to the GitHub repository's automation and templates:

1. PR Template Updates:

   • The pull request template has been revised to include clearer sections such as "What and why?", "How to test", "What needs special review?", and "Dependencies, breaking changes, and deployment notes". This provides improved guidance for both submitters and reviewers.

2. Release Notes Check Enhancements:

   • The release notes check script now considers the presence of an additional label, "dependencies", along with "internal", to bypass further checks. This change enables better categorization of PRs based on their context.

3. AI Explanation Workflow Improvements:

   • In the AI explanation workflow script, a unique COMMENT_MARKER is added to easily identify existing AI comments. The script now collects all previous comments with this marker and deletes them, ensuring that outdated explanations are removed.
   • The token encoding and truncation logic has been removed, streamlining the preparation of the prompt before sending it to OpenAI.
   • The workflow now uses the "o3-mini" model instead of "gpt-4o".

4. GitHub Actions Workflow Updates:

   • The Python setup action has been updated from version v2 to v5, and the specific version of Python (3.11) is now enforced.
   • The environment variable for the OpenAI API key is changed from OPENAI_API_KEY to OPENAI_PR_SUMMARY_KEY for clarity.
   • The pull request permissions have been modified from write to read, reducing unnecessary permissions.

Collectively, these changes improve the clarity of PR descriptions, enhance the maintainability of automated workflows, and streamline interaction with the OpenAI API.

Test Suggestions

• Submit a PR using the new template and verify that all the updated sections and checkboxes appear as expected.
• Test the release notes check by adding the 'internal' and 'dependencies' labels on a dummy PR and ensure the script bypasses the check appropriately.
• Create several AI explanation comments on a PR and verify that only one up-to-date comment remains after the workflow execution.
• Run the AI explanation workflow to ensure that it correctly calls the OpenAI API with the new settings and posts the comment with the unique marker.
• Confirm that the new GitHub Actions workflow uses Python 3.11 and that the environment variable OPENAI_PR_SUMMARY_KEY is correctly read.