Skip to content

Document plugin step inputs for summary generation#50

Merged
mw-hrastega merged 9 commits into
masterfrom
generate-summary-doc
Jun 5, 2026
Merged

Document plugin step inputs for summary generation#50
mw-hrastega merged 9 commits into
masterfrom
generate-summary-doc

Conversation

@mw-hrastega

Copy link
Copy Markdown

Review request for @mw-kapilg:

Please take a look at the doc changes regarding summary generation.

@mw-hrastega

Copy link
Copy Markdown
Author

Tentative release note:

Features

  • You can control whether to generate build and test summaries on the Jenkins build summary page by using:

    • The Generate summary option of the Run MATLAB Build, Run MATLAB Tests, and Run MATLAB Command steps
    • The generateSummary input of the runMATLABBuild, runMATLABTests, runMATLABCommand steps

    For example, if you specify the generateSummary input of a runMATLABBuild step as false, the step does not genrate build and test summaries.

@mw-kapilg mw-kapilg left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thanks for working on this Houman! Added some clarifying questions and suggestions.

Also, we should probably update screenshots to show the latest UI (that includes "Generate Summary" checkbox). I'm also wondering if we should have a screenshot that shows "Generate Summary" checkbox, basically where that option exists in a step. That screenshot can be in the "View MATLAB Build and Test Results" section. I'm okay with not adding as well, just wanted to throw that out

Comment thread CONFIGDOC.md Outdated
Comment thread CONFIGDOC.md Outdated
Comment thread CONFIGDOC.md Outdated
@mw-kapilg mw-kapilg self-requested a review June 4, 2026 16:14
@mw-hrastega

Copy link
Copy Markdown
Author

Thanks for working on this Houman! Added some clarifying questions and suggestions.

Also, we should probably update screenshots to show the latest UI (that includes "Generate Summary" checkbox). I'm also wondering if we should have a screenshot that shows "Generate Summary" checkbox, basically where that option exists in a step. That screenshot can be in the "View MATLAB Build and Test Results" section. I'm okay with not adding as well, just wanted to throw that out

Thanks, Kapil, for your comments and for flagging the screenshots. Two screenshots needed an update. I don't think we need to include a new screenshot in the "View MATLAB Build and Test Results" section because the Generate summary option is very clear. I was considering adding a screenshot in the "Specify Build Steps" section, but thought it would be redundant because the screenshot of the Run MATLAB Build step quickly follows that section.

Please take another look at the changes and let me know if you notice any other issues. Thanks again.

@mw-kapilg mw-kapilg left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM, thanks for incorporating all the feedback! :shipit:

@mw-hrastega mw-hrastega merged commit edac5ea into master Jun 5, 2026
4 of 6 checks passed
@mw-hrastega mw-hrastega deleted the generate-summary-doc branch June 5, 2026 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants