Skip to content

PR desc check action #32

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

Jump to bottom
Merged
merged 32 commits into from
May 23, 2025
Merged

PR desc check action #32

merged 32 commits into from
May 23, 2025

Conversation

@YanxuanLiu
Copy link
Collaborator

@YanxuanLiu YanxuanLiu commented May 22, 2025

YanxuanLiu added 3 commits May 22, 2025 14:37
@YanxuanLiu
add pr-desc-check action
3365e34 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
change action name
b279046 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
add shell
de6dcb2 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu YanxuanLiu requested a review from a team as a code owner May 22, 2025 06:55
@YanxuanLiu YanxuanLiu self-assigned this May 22, 2025
@YanxuanLiu YanxuanLiu requested review from NvTimLiu, pxLi and yinqingh May 22, 2025 06:56
@pxLi pxLi requested a review from gerashegalov May 22, 2025 06:58
pxLi
pxLi previously approved these changes May 22, 2025
View reviewed changes
Copy link
Member

@pxLi pxLi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add the check ref to this change directly for common repo, thanks

@pxLi pxLi dismissed their stale review May 22, 2025 07:01

accidental ops

@YanxuanLiu
add action
fbbf95b 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
Copy link
Collaborator Author

YanxuanLiu commented May 22, 2025

Lets add the check ref to this change directly for common repo, thanks

Added. Should we skip for [bot] PR? Currently I set to skip.

@pxLi
Copy link
Member

pxLi commented May 22, 2025

Lets add the check ref to this change directly for common repo, thanks

Added. Should we skip for [bot] PR? Currently I set to skip.

Yes, that would be better~

pxLi
pxLi reviewed May 22, 2025
View reviewed changes
pr-description-check/action.yml Outdated
uses: actions/github-script@v7
with:
script: |
return context.payload.pull_request?.body || '';
Copy link
Member

@pxLi pxLi May 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: looks like github-script could cover the whole process and also leverage the core.setFailed() to update the fail message to the check status directly. Can you try ask LLM to generate some JS code if possible, thanks
image

Copy link
Collaborator Author

@YanxuanLiu YanxuanLiu May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, implemented the action with github script only.

new test run:
failed: https://github.com/YanxuanLiu/spark-rapids/actions/runs/15180719652/job/42689410812?pr=27
success: https://github.com/YanxuanLiu/spark-rapids/actions/runs/15180729669/job/42689437585?pr=27

Copy link
Member

@pxLi pxLi May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have the screenshot for the failed one in check status? Or let me edit again

Copy link
Collaborator Author

@YanxuanLiu YanxuanLiu May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
image

Now we can update the status in PR check list

Copy link
Member

@pxLi pxLi May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! can we make merge them into the same check instead of create another status item

Copy link
Collaborator Author

@YanxuanLiu YanxuanLiu May 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optimized the context name:
image
image

@pxLi pxLi requested a review from Copilot May 22, 2025 07:21
Copilot AI reviewed May 22, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a GitHub Action to check for HTML comments in pull request descriptions, addressing issue #31.

  • Added a new composite GitHub Action in pr-description-check/action.yml that extracts the PR description and checks for HTML comments.
  • Defined a new workflow in .github/workflows/pr-desc-check.yml that triggers the action on PR events.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
pr-description-check/action.yml Adds a composite action that fetches the PR description and validates its content.
.github/workflows/pr-desc-check.yml Sets up a workflow to run the PR Description Check action on PR events.

YanxuanLiu added 3 commits May 22, 2025 15:28
@YanxuanLiu
simplify the action
9af22eb 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
change to new error
c144f81 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
test API
c6b51a9 
Signed-off-by: Yanxuan Liu <[email protected]>
@pxLi pxLi marked this pull request as draft May 22, 2025 07:48
@pxLi
Copy link
Member

pxLi commented May 22, 2025

convert to draft first to test against API call

YanxuanLiu added 8 commits May 22, 2025 15:49
@YanxuanLiu
test API
98d02d2 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
test API in js format
8343ce8 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
update token
27fb716 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
git token
c3da522 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
change token name
c8d3d4c 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
get token from input
f66e2c4 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
import Octokit
fa07a7a 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
use default octokit
0dbbb89 
Signed-off-by: Yanxuan Liu <[email protected]>
YanxuanLiu added 14 commits May 22, 2025 16:47
@YanxuanLiu
fix bug
f7e1418 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
use default token
5b08aba 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
import github object
7edbe6c 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
test
220d8ba 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
test
bb95200 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
use octokit
0b9152e 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
use script
8ec768b 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
fix
28c3030 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
for test
18efef7 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
simplify
e5e8468 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
log
d9c475d 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
add github token
f818c56 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
fix bug of secrets
9d0e3c4 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
update action
3d1cbd4 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu YanxuanLiu marked this pull request as ready for review May 23, 2025 06:06
@YanxuanLiu YanxuanLiu marked this pull request as draft May 23, 2025 06:19
YanxuanLiu added 2 commits May 23, 2025 14:30
@YanxuanLiu
test
b664fb1 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
test
610da5c 
Signed-off-by: Yanxuan Liu <[email protected]>
@YanxuanLiu
rename context
08d41fe 
Signed-off-by: Yanxuan Liu <[email protected]>
pxLi
pxLi approved these changes May 23, 2025
View reviewed changes
Copy link
Member

@pxLi pxLi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, please help apply the action to spark-rapids first after merge, thanks

@YanxuanLiu YanxuanLiu marked this pull request as ready for review May 23, 2025 06:59
@YanxuanLiu YanxuanLiu merged commit 64aa18a into NVIDIA:main May 23, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@pxLi pxLi pxLi approved these changes

@yinqingh yinqingh Awaiting requested review from yinqingh

@NvTimLiu NvTimLiu Awaiting requested review from NvTimLiu

@gerashegalov gerashegalov Awaiting requested review from gerashegalov

Assignees

@YanxuanLiu YanxuanLiu

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[FEA] create a shared check to notify if PR description still includes html comments

2 participants

@YanxuanLiu @pxLi