[gha] Automatically add job link to PR description #3453
Merged
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
Collaborator
Author
|
Example of PR description AlexanderDokuchaev#37 |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR automates the addition of a job link to the pull request description when the workflows are manually triggered.
Key changes:
- Introduces a new "update-pr-description" job in several workflow files (.github/workflows/macos.yml, install.yml, examples.yml, conformance_weight_compression.yml).
- Implements a composite GitHub Action in .github/actions/add_job_link/action.yml that updates the PR description with a link to the corresponding workflow run.
- Enables manual triggering by checking for a non-empty pull_request_number in the workflow's input.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/macos.yml | Adds a new job to update the PR description post testing |
| .github/workflows/install.yml | Introduces update-pr-description job for install workflow tasks |
| .github/workflows/examples.yml | Implements update-pr-description job in examples workflow |
| .github/workflows/conformance_weight_compression.yml | Adds update-pr-description job for conformance-weight compression testing |
| .github/actions/add_job_link/action.yml | Defines a composite action to update the PR description with the job link |
Comments suppressed due to low confidence (1)
.github/workflows/macos.yml:75
- [nitpick] The step name 'Update PR preview link' is slightly misleading given that the job updates the PR description. Consider renaming it to 'Update PR description' for clarity.
- name: Update PR preview link
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR automates the addition of a job link to a PR description by introducing a new composite action and updating several GitHub workflow files.
- Added a job "update-pr-description" to the macos, install, examples, and conformance_weight_compression workflows.
- Introduced a new composite action in .github/actions/add_job_link to update the PR description with a link.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/macos.yml | Added a new job to update the PR description for the MacOS workflow. |
| .github/workflows/install.yml | Added a new job to update the PR description for the install workflow. |
| .github/workflows/examples.yml | Introduced the update-pr-description job for the examples workflow. |
| .github/workflows/conformance_weight_compression.yml | Added the update-pr-description job for the conformance weight compression workflow. |
| .github/actions/add_job_link/action.yml | New composite action to add a job link to the PR description. |
ljaljushkin
approved these changes
Apr 24, 2025
AlexanderDokuchaev
added a commit
that referenced
this pull request
Apr 25, 2025
This reverts commit dd99ed5.
AlexanderDokuchaev
added a commit
that referenced
this pull request
Apr 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes
Add action
add_job_linkto add job link in the end of PR descriptionUpdate workflow that can be run manually for PR
Reason for changes
Laziness