-
-
Notifications
You must be signed in to change notification settings - Fork 149
Add job_summary_text input to include custom text in job summary
#1439
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
Conversation
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||||
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.
Pull Request Overview
This PR adds a new job_summary_text input parameter that allows users to include custom text at the beginning of the job summary before the test result tables.
- Added
job_summary_textinput parameter to action.yml with description and default empty value - Modified the
attachSummaryfunction to accept and render custom summary text when provided - Updated the build workflow to demonstrate the new functionality with example markdown content
Reviewed Changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| action.yml | Defines the new job_summary_text input parameter |
| src/main.ts | Retrieves the input value and passes it to the summary function |
| src/annotator.ts | Updates attachSummary function to handle and render custom text |
| .github/workflows/build.yml | Adds example usage of the new parameter in the test workflow |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/annotator.ts
Outdated
| ): Promise<void> { | ||
| // Add summary text if provided | ||
| if (summaryText) { | ||
| await core.summary.addRaw(summaryText).write() |
Copilot
AI
Oct 10, 2025
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.
The summary is being written immediately after adding the custom text, which will create separate summary sections. This should use addRaw(summaryText) without .write() to append to the summary, then write once at the end with all other content.
| await core.summary.addRaw(summaryText).write() | |
| core.summary.addRaw(summaryText) |
add
job_summary_textinput to include custom text in job summarysummaryinput is nowhere to be found #1435