[CONFLICT] [Backport stable-25-3] PR 29702: Badges to PR body #29786
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the PR comment script to include a workflow run URL in comments, improving traceability of test runs. It also modifies message formatting for better visibility. Additionally, a new script for local validation of PR descriptions is introduced, allowing users to test and validate PR bodies before submission. This script supports table generation for test execution and backport actions based on environment configurations. Key changes: - Updated `create_or_update_comment` function to accept and display workflow run URL. - Improved message formatting in PR comments. - Added `test_validation.py` for local PR description validation and table generation testing. - Enhanced table generation logic in `validate_pr_description.py` to support side-by-side display of test and backport tables.
…ts action This commit enhances the GitHub Actions workflow by adding the `run_tests` action to the sparse checkout configuration. This change ensures that the necessary files for running tests are included in the checkout process, improving the workflow's efficiency and reliability. Key changes: - Added `.github/actions/run_tests/` to the sparse checkout list.
This commit updates the `cherry_pick_v2.py` script to ensure consistent use of type hints by removing unnecessary comments that specify the `PullRequest` type. This change enhances code clarity and maintains flexibility in handling various object types. Key changes: - Removed comments indicating specific types for `pull_requests` and related functions. - Streamlined function signatures to improve readability and maintainability.
This commit improves the error handling in the `pr_comment.py` and `validate_pr_description.py` scripts by adding try-except blocks around critical operations. This change ensures that failures in updating comments or PR bodies are logged with appropriate error messages, enhancing the robustness and traceability of the scripts. Key changes: - Added error handling for comment updates and creations in `pr_comment.py`. - Implemented error handling for PR body updates in `validate_pr_description.py`. - Introduced checks for required environment variables to prevent runtime errors.
This commit updates the `validate_pr_description.py` script to check for the presence of a legend in the PR body before appending it. If the legend already exists, it will not be added again, improving the clarity and conciseness of PR descriptions. Key changes: - Added a check for the legend's existence in the PR body. - Modified the logic for appending tables and the legend to ensure no duplicates are included.
This commit enhances the `test_validation.py` script by adding functionality to automatically determine the GitHub repository from the git remote URL. This improvement allows for better local testing by setting the `GITHUB_REPOSITORY` environment variable if it is not already defined. Key changes: - Introduced `find_github_repository` function to extract the repository name from the git remote URL. - Updated the main function to set `GITHUB_REPOSITORY` for local testing, improving usability and reducing manual setup requirements. - Enhanced documentation to clarify the automatic setting of `GITHUB_WORKSPACE` and `GITHUB_REPOSITORY` environment variables.
…te_pr_description.py`. The script now directly uses the PR body for validation, streamlining the process and improving usability.
This commit modifies the `validate_pr_description` workflow to introduce two new environment variables: `SHOW_RUN_TESTS_IN_PR` and `SHOW_BACKPORT_IN_PR`. These flags control the inclusion of test execution and backport tables in the PR body. The `ensure_tables_in_pr_body` function is updated to handle these flags, allowing for more flexible table generation based on user requirements. Key changes: - Replaced `SHOW_ADDITIONAL_INFO_IN_PR` with the new flags in the action configuration. - Updated `test_validation.py` to reflect the new environment variables and their usage. - Enhanced `validate_pr_description.py` to conditionally add tables based on the new flags, improving the clarity and usability of PR descriptions.
This commit enhances the `generate_backport_table` function in `validate_pr_description.py` to collect and sort unique branches from the input. The changes ensure that the backporting URL is generated for all unique branches, improving the accuracy and clarity of the backport table in PR descriptions. Key changes: - Updated logic to collect unique branches from multiple entries. - Sorted branches for consistent output. - Modified the backport button label for clarity.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
🟢 |
|
⚪
🟢 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog entry
Badges to PR body: ...
Not for changelog (changelog entry is not required)
Changelog category
Description for reviewers
Original PR(s)
Metadata
Conflicts Require Manual Resolution
This PR contains merge conflicts that require manual resolution.
Files with conflicts:
How to resolve conflicts:
After resolving conflicts:
[CONFLICT]if conflicts are resolved)Git Cherry-Pick Log
PR was created by cherry-pick workflow run