GenerateReleaseNotes Tasks YAML

(deprecated) Generate Release Notes Build Task (PowerShell)

The '(deprecated) Generate Release Notes Build Task (PowerShell)' package contains the following tasks. The table show the possible variables that can be used in YAML Azure DevOps Pipeline configurations

GenerateReleaseNotes V3

(deprecated) Task is now deprecated. Please consider my Cross Platform Version https://marketplace.visualstudio.com/items?itemName=richardfennellBM.BM-VSTS-XplatGenerateReleaseNotes

YAML snippet

# (deprecated) Generate Release Notes for Pipeline Builds or Releases (PowerShell)
# Description - (deprecated) Task is now deprecated. Please consider my Cross Platform Version https://marketplace.visualstudio.com/items?itemName=richardfennellBM.BM-VSTS-XplatGenerateReleaseNotes 
- task: GenerateReleaseNotes@3
  inputs: 
     # Required arguments
     outputfile: 
     templateLocation: File
     templatefile: 
     inlinetemplate: 
     generateForOnlyPrimary: False
     generateForOnlyTriggerArtifact: False

Arguments

• Argument: outputfile
  • Description: The name of the Markdown file to export e.g. $(Build.ArtifactStagingDirectory)\releasenotes.md if within a build workflow
  • Type: string
  • Required: true
  • Default (if defined):
• Argument: templateLocation
  • Description: Select the template file source, file in source control or in line.
  • Type: pickList
  • Required: true
  • Default (if defined): File
• Argument: templatefile
  • Description: The name of the Markdown template.
  • Type: filePath
  • Required: true
  • Default (if defined):
• Argument: inlinetemplate
  • Description: The Markdown template.
  • Type: multiLine
  • Required: true
  • Default (if defined):

Advanced

• Argument: usedefaultcreds
  • Description: If true will use the credentials of the running agent as opposed to access token provided by build service.
  • Type: boolean
  • Required: false
  • Default (if defined): False
• Argument: emptySetText
  • Description: This is the text that will be placed in the generated release notes if there are no work items or changesets/commits.
  • Type: string
  • Required: false
  • Default (if defined): None
• Argument: generateForOnlyPrimary
  • Description: If true will generate release notes for the primary build artifact (Release usage only)
  • Type: boolean
  • Required: true
  • Default (if defined): False
• Argument: generateForOnlyTriggerArtifact
  • Description: If true will generate release notes for the trigger build artifact (Release usage only)
  • Type: boolean
  • Required: true
  • Default (if defined): False
• Argument: generateForCurrentRelease
  • Description: If true will generate release notes for this release (Release usage only)
  • Type: boolean
  • Required: false
  • Default (if defined): True
• Argument: overrideStageName
  • Description: If set uses this stage name to find the last succesful deployment, as opposed to the currently active stage (Release usage only)
  • Type: string
  • Required: false
  • Default (if defined):
• Argument: maxWi
  • Description: The maximum Work Items to return in the report
  • Type: integer
  • Required: false
  • Default (if defined): 50
• Argument: maxChanges
  • Description: The maximum Changeset/Commits to return in the report
  • Type: integer
  • Required: false
  • Default (if defined): 50
• Argument: appendToFile
  • Description: A boolean flag whether to over-write output file or append to it.
  • Type: boolean
  • Required: false
  • Default (if defined): False
• Argument: showParents
  • Description: A boolean flag whether to added parent work items of those associated with a build.
  • Type: boolean
  • Required: false
  • Default (if defined): False
• Argument: wiFilter
  • Description: A comma-separated list of Work Item types to include in the report. Use this to exclude Tasks, for instance.
  • Type: string
  • Required: false
  • Default (if defined):
• Argument: wiStateFilter
  • Description: A comma-separated list of Work Item states to include in the report.
  • Type: string
  • Required: false
  • Default (if defined):
• Argument: unifiedList
  • Description: A boolean flag whether when running inside a release the WI/Commit for all builds are returned as a single list
  • Type: boolean
  • Required: false
  • Default (if defined): False
• Argument: buildTags
  • Description: A comma-separated list of build tags.
  • Type: string
  • Required: false
  • Default (if defined):

Outputs

• Argument: outputVariableName
  • Description: The name of the variable that the markdown output should be assigned to for use later in your workflow.
  • Type: string
  • Required: false
  • Default (if defined):