---
title: "Generate Release Notes"
---
Generates an HTML file containing the BuildMaster release notes and/or issues from the application's issue tracking provider.
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.
Name | Format | Script Usage | Usage Notes |
---|---|---|---|
☆ File name | text | Name | This argument is required. |
Include release notes | true/false | IncludeReleaseNotes | Default value is "True". |
Include issue summary | true/false | IncludeIssueSummary | Default value is "True". |
Include issue descriptions | true/false | IncludeIssueDescriptions | Default value is "True". |
Closed issues only | true/false | ClosedIssuesOnly | |
Custom CSS | text | CustomCss | |
Overwrite | true/false | Overwrite |
# generates an HTML file containing this application's issues with descriptions along with release notes
Generate-ReleaseNotes(
Name: notes.html
);