Generate Release Notes
- 14 May 2021
- 1 Minute to read
- Print
- DarkLight
- PDF
Generate Release Notes
- Updated on 14 May 2021
- 1 Minute to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.
Generate Release Notes
Generates an HTML file containing the BuildMaster release notes and/or issues from the application's issue tracking provider.
Script usage:
Generate-ReleaseNotes( Name: <text>, [IncludeReleaseNotes: <true/false>], [IncludeIssueSummary: <true/false>], [IncludeIssueDescriptions: <true/false>], [ClosedIssuesOnly: <true/false>], [CustomCss: <text>], [Overwrite: <true/false>] );
This operation may be prefixed with Core::, although this is a built-in namespace and isn't really necessary.
Arguments:
| Name | Format | Script Usage | Usage Notes |
|---|---|---|---|
| ☆ File name | text | Name | This argument is required. |
| Include release notes | true/false | IncludeReleaseNotes | |
| Include issue summary | true/false | IncludeIssueSummary | |
| Include issue descriptions | true/false | IncludeIssueDescriptions | |
| Closed issues only | true/false | ClosedIssuesOnly | |
| Custom CSS | text | CustomCss | |
| Overwrite | true/false | Overwrite |
Example:
# generates an HTML file containing this application's issues with descriptions along with release notes
Generate-ReleaseNotes(
Name: notes.html
);
Was this article helpful?
