task.json

{
  "id": "661BC005-61BE-430F-B994-065BF08C0F39",
  "name": "GenerateReleaseNotes",
  "friendlyName": "Generate Release Notes",
  "description": "Generates a release notes file in a format of your choice",
    "helpMarkDown": "Version: #{Build.BuildNumber}#. [More Information](https://github.com/rfennell/vNextBuild/wiki/GenerateReleaseNotes%20-Tasks/)",

  "category": "Utility",
  "visibility": [
                "Build"
                ],
  "author": "Black Marble",
  "version": {
    "Major": 1,
    "Minor": 0,
    "Patch": 0
  },
  "minimumAgentVersion": "1.82.0",
  "groups": [
    {
      "name": "advanced",
      "displayName": "Advanced",
      "isExpanded": false
    },
     {
      "name": "outputs",
      "displayName": "Outputs",
      "isExpanded": false
    }
  ],
  "inputs": [
    {
      "name": "outputfile",
      "type": "string",
      "label": "Output file",
      "defaultValue": "",
      "required": true,
      "helpMarkDown": "The name of the Markdown file to export e.g. $(Build.ArtifactStagingDirectory)\\releasenotes.md if within a build workflow "
    },
    {
      "name": "outputVariableName",
      "type": "string",
      "label": "Output variable",
      "defaultValue": "",
      "required": false,
      "helpMarkDown": "The name of the variable that the markdown output should be assigned to for use later in your workflow.",
      "groupName": "outputs"
    },
    {
      "name": "templateLocation",
      "type": "pickList",
      "label": "Template Location",
      "defaultValue": "File",
      "required": true,
      "options": {
        "File": "File",
        "InLine": "InLine"
      },
      "helpMarkDown": "Select the template file source, file in source control or in line."
    },
    {
      "name": "templatefile",
      "type": "filePath",
      "label": "Template file",
      "defaultValue": "",
      "required": true,
      "helpMarkDown": "The name of the Markdown template.",
      "visibleRule": "templateLocation = File"
    },
    {
      "name": "inlinetemplate",
      "type": "multiLine",
      "label": "Template",
      "defaultValue": "",
      "required": true,
      "helpMarkDown": "The Markdown template.",
      "visibleRule": "templateLocation = InLine"
    },
    {
      "name": "usedefaultcreds",
      "type": "boolean",
      "label": "Use default credentials",
      "defaultValue": "False",
      "required": false,
      "helpMarkDown": "If true will use the credentials of the running agent as opposed to access token provided by build service.",
      "groupName": "advanced"
    },
    {
      "name": "emptySetText",
      "type": "string",
      "label": "Text for empty sets",
      "defaultValue": "None",
      "required": false,
      "helpMarkDown": "This is the text that will be placed in the generated release notes if there are no work items or changesets/commits.",
      "groupName": "advanced"
    },
    {
      "name": "generateForOnlyPrimary",
      "type": "boolean",
      "label": "Generate for only primary artifact",
      "defaultValue": "False",
      "required": true,
      "helpMarkDown": "If true will generate release notes for the primary build artifact (Release usage only)",
      "groupName": "advanced"
    },
    {
      "name": "generateForCurrentRelease",
      "type": "boolean",
      "label": "Generate for only this Release",
      "defaultValue": "True",
      "required": false,
      "helpMarkDown": "If true will generate release notes for this release (Release usage only)",
      "groupName": "advanced"
    },
    {
      "name": "overrideStageName",
      "type": "string",
      "label": "Name of stage (override)",
      "defaultValue": "",
      "required": false,
      "helpMarkDown": "If set uses this stage name to find the last succesful deployment, as opposed to the currently active stage (Release usage only)",
      "groupName": "advanced",
      "visibleRule": "generateForCurrentRelease = false"
    },
    {
      "name": "maxWi",
      "type": "integer",
      "label": "Maximum Work Items to return",
      "defaultValue": "50",
      "required": false,
      "helpMarkDown": "The maximum Work Items to return in the report",
      "groupName": "advanced"
    },
    {
      "name": "maxChanges",
      "type": "integer",
      "label": "Maximum Changeset/Commits to return",
      "defaultValue": "50",
      "required": false,
      "helpMarkDown": "The maximum Changeset/Commits to return in the report",
      "groupName": "advanced"
    },
    {
      "name": "appendToFile",
      "type": "boolean",
      "label": "Append output file",
      "defaultValue": "False",
      "required": false,
      "helpMarkDown": "A boolean flag whether to over-write output file or append to it.",
      "groupName": "advanced"
    },
    {
      "name": "showParents",
      "type": "boolean",
      "label": "Show parent workitems",
      "defaultValue": "False",
      "required": false,
      "helpMarkDown": "A boolean flag whether to added parent work items of those associated with a build.",
      "groupName": "advanced"
    },
    {
      "name": "wiFilter",
      "type": "string",
      "label": "List of Work Item types to include",
      "defaultValue": "",
      "required": false,
      "helpMarkDown": "A comma-separated list of Work Item types to include in the report. Use this to exclude Tasks, for instance.",
      "groupName": "advanced",
      "visibleRule": "showParents = true"
    },
    {
      "name": "wiStateFilter",
      "type": "string",
      "label": "List of Work Item states to include",
      "defaultValue": "",
      "required": false,
      "helpMarkDown": "A comma-separated list of Work Item states to include in the report.",
      "groupName": "advanced",
      "visibleRule": "showParents = true"
    }    ,
    {
      "name": "unifiedList",
      "type": "boolean",
      "label": "Unified WI/Commits",
      "defaultValue": "False",
      "required": false,
      "helpMarkDown": "A boolean flag whether when running inside a release the WI/Commit for all builds are returned as a single list",
      "groupName": "advanced"
     }
  ],
  "instanceNameFormat": "Generate release notes",
  "execution": {
    "PowerShell": {
      "target": "$(currentDirectory)\\GenerateReleaseNotes.ps1",
      "argumentFormat": "",
      "workingDirectory": "$(currentDirectory)"
    }
  }
}