Add generateSummary option to control result summary generation

[mw-kapilg]

Summary

• Add a generateSummary option (default: true) to all three MATLAB steps — Run MATLAB Build, Run MATLAB Command, and Run MATLAB Tests — allowing users to opt out of result summary generation
• Modify getDefaultPlugins.m to conditionally include the BuildReportPlugin based on the MW_INPUT_GENERATE_SUMMARY environment variable

Backward Compatibility

• Freestyle projects: Uses Boolean wrapper type with readResolve() to default existing saved configs to true
• Pipeline steps: Uses boolean primitive with field initializer as true

How it looks in Jenkins UI

For Run MATLAB Command step:

For Run MATLAB Tests step:

For Run MATLAB Build step (also added a new "Customize Build Run" section below):

[mw-hrastega]

Summary

• Add a generateSummary option (default: true) to all three MATLAB steps — Run MATLAB Build, Run MATLAB Command, and Run MATLAB Tests — allowing users to opt out of result summary generation
• Modify getDefaultPlugins.m to conditionally include the BuildReportPlugin based on the MW_INPUT_GENERATE_SUMMARY environment variable

Backward Compatibility

• Freestyle projects: Uses Boolean wrapper type with readResolve() to default existing saved configs to true
• Pipeline steps: Uses boolean primitive with field initializer as true

How it looks in Jenkins UI

For Run MATLAB Command step: For Run MATLAB Tests step: For Run MATLAB Build step (also added a new "Customize Build Run" section below):

Hi @mw-kapilg , I have no flags regarding "Generate Results Summary" as the label, but what do you think about a shorter label (i.e., Generate Summary)? (@sameagen-MW: Do you have any flags about the inclusion of Results in Generate Results Summary for the Run MATLAB Command step?)

Regarding the help text, maybe we can use a similar pattern as for the MATLAB actions (matlab-actions/run-build#75). In the plugin doc (https://github.com/jenkinsci/matlab-plugin/blob/master/CONFIGDOC.md#view-matlab-build-and-test-results), we have "Jenkins build summary page". So, perhaps something like this?

Option to generate a summary for the Jenkins build summary

[mw-kapilg]

Hi @mw-kapilg , I have no flags regarding "Generate Results Summary" as the label, but what do you think about a shorter label (i.e., Generate Summary)? (@sameagen-MW: Do you have any flags about the inclusion of Results in Generate Results Summary for the Run MATLAB Command step?)

Regarding the help text, maybe we can use a similar pattern as for the MATLAB actions (matlab-actions/run-build#75). In the plugin doc (https://github.com/jenkinsci/matlab-plugin/blob/master/CONFIGDOC.md#view-matlab-build-and-test-results), we have "Jenkins build summary page". So, perhaps something like this?

Option to generate a summary for the Jenkins build summary

Thanks for the suggestions Houman! I'm fine with the shorter "Generate summary" (Notice, s is lowercase to match with other field display names).
I have updated the display and help texts.

[mw-hrastega]

Hi @mw-kapilg , I have no flags regarding "Generate Results Summary" as the label, but what do you think about a shorter label (i.e., Generate Summary)? (@sameagen-MW: Do you have any flags about the inclusion of Results in Generate Results Summary for the Run MATLAB Command step?)
Regarding the help text, maybe we can use a similar pattern as for the MATLAB actions (matlab-actions/run-build#75). In the plugin doc (https://github.com/jenkinsci/matlab-plugin/blob/master/CONFIGDOC.md#view-matlab-build-and-test-results), we have "Jenkins build summary page". So, perhaps something like this?

Option to generate a summary for the Jenkins build summary

Thanks for the suggestions Houman! I'm fine with the shorter "Generate summary" (Notice, s is lowercase to match with other field display names). I have updated the display and help texts.

Thanks, Kapil. The changes look good! I just have a couple of clarifying questions:

1. The pipeline API, such as the runMATLABBuild step, also supports the new generateSummary input. Could you confirm this?
2. In the screenshots above, the new option appears after the “Startup options” option. What are the pros and cons of placing the new option before versus after “Startup options”?

[mw-kapilg]

Thanks, Kapil. The changes look good! I just have a couple of clarifying questions:

1. The pipeline API, such as the runMATLABBuild step, also supports the new generateSummary input. Could you confirm this?
2. In the screenshots above, the new option appears after the “Startup options” option. What are the pros and cons of placing the new option before versus after “Startup options”?

1. Yes, it works for pipeline projects as well
2. I think startupOptions would be used more often than the generateSummary field. Only in rare scenarios would someone prefer to turn summary generation off (it's on by default). Also, for test results summary, it is only generated if the user has a MATLAB Test license which also lowers the occurrences of summary generation.

[mw-hrastega]

Thanks, Kapil. The changes look good! I just have a couple of clarifying questions:

1. The pipeline API, such as the runMATLABBuild step, also supports the new generateSummary input. Could you confirm this?
2. In the screenshots above, the new option appears after the “Startup options” option. What are the pros and cons of placing the new option before versus after “Startup options”?

1. Yes, it works for pipeline projects as well
2. I think startupOptions would be used more often than the generateSummary field. Only in rare scenarios would someone prefer to turn summary generation off (it's on by default). Also, for test results summary, it is only generated if the user has a MATLAB Test license which also lowers the occurrences of summary generation.

Thanks for answering my questions.