-
Notifications
You must be signed in to change notification settings - Fork 315
[jsweep] Clean add_workflow_run_comment.cjs #23208
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.
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
Merged
pelikhan
merged 2 commits into
main
from
jsweep/add-workflow-run-comment-469d40b1a3d771d2
Mar 28, 2026
+64
−12
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,6 +50,7 @@ describe("add_workflow_run_comment", () => { | |
| delete process.env.GH_AW_TRACKER_ID; | ||
| delete process.env.GH_AW_LOCK_FOR_AGENT; | ||
| delete process.env.GITHUB_SERVER_URL; | ||
| delete process.env.GH_AW_SAFE_OUTPUT_MESSAGES; | ||
|
|
||
| // Reset context to default | ||
| global.context = { | ||
|
|
@@ -423,4 +424,55 @@ describe("add_workflow_run_comment", () => { | |
| expect(mockCore.setOutput).toHaveBeenCalledWith("comment-repo", "testowner/testrepo"); | ||
| }); | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good addition: the |
||
| }); | ||
|
|
||
| describe("main() - activation comments disabled", () => { | ||
| it("should skip comment when activationComments is false", async () => { | ||
| process.env.GH_AW_SAFE_OUTPUT_MESSAGES = JSON.stringify({ activationComments: false }); | ||
| global.context = { | ||
| eventName: "issues", | ||
| runId: 12345, | ||
| repo: { owner: "testowner", repo: "testrepo" }, | ||
| payload: { | ||
| issue: { number: 456 }, | ||
| repository: { html_url: "https://github.com/testowner/testrepo" }, | ||
| }, | ||
| }; | ||
|
|
||
| await runScript(); | ||
|
|
||
| expect(mockGithub.request).not.toHaveBeenCalled(); | ||
| expect(mockCore.setFailed).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| describe("main() - issue_comment missing number", () => { | ||
| it("should fail when issue number is missing in issue_comment event", async () => { | ||
| global.context = { | ||
| eventName: "issue_comment", | ||
| runId: 12345, | ||
| repo: { owner: "testowner", repo: "testrepo" }, | ||
| payload: {}, | ||
| }; | ||
|
|
||
| await runScript(); | ||
|
|
||
| expect(mockCore.setFailed).toHaveBeenCalledWith(`${ERR_NOT_FOUND}: Issue number not found in event payload`); | ||
| expect(mockGithub.request).not.toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
|
|
||
| describe("addCommentWithWorkflowLink() - custom workflow name", () => { | ||
| it("should use GH_AW_WORKFLOW_NAME in the comment body", async () => { | ||
| process.env.GH_AW_WORKFLOW_NAME = "My Custom Workflow"; | ||
|
|
||
| await runAddCommentWithWorkflowLink("/repos/testowner/testrepo/issues/123/comments", "https://github.com/testowner/testrepo/actions/runs/12345", "issues"); | ||
|
|
||
| expect(mockGithub.request).toHaveBeenCalledWith( | ||
| expect.stringContaining("POST"), | ||
| expect.objectContaining({ | ||
| body: expect.stringContaining("My Custom Workflow"), | ||
| }) | ||
| ); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good rename from
issueNumbertonumber— the variable is now consistent across all event handler cases, reducing cognitive overhead when reading the switch block.