Question regarding WorkItems

[Quallos]

Hello!

Sorry I am a bit new to handlebar templates and also azure pipeline.

I am trying to figure out how to get workitems inside of my template.

This is a snippet of my template:

`

XXX API TITLE

Release Notes for {{buildDetails.buildNumber}}RSION

These are the most updated Workitems

Total Number of Work Items: {{workItems.length}}
`
It returns 0 which is not true.

Here is a piece of my logs inside the pipeline:

Loading template file /opt/vsts_agent/_work/1/s/xxxxxx.md
##[debug]Loading handlebar template
##[debug]Processing template
##[debug] WI: 0
##[debug] CS: 1
##[debug] PR: 0
##[debug] Builds: 0
##[debug] Manual Tests: 0
##[debug] Manual TestConfigurations: 0
##[debug] Release Tests: 0
##[debug] Related WI: 0
##[debug] Related Tests: 0
##[debug] Indirect PR: 0
##[debug] Consumed Artifacts: 0
##[debug] Published Artifacts: 0
##[debug] Query WI: 13
##[debug]Processing handlebar template
Loading handlebars-helpers extension

Here is my Task Setup

      - task: XplatGenerateReleaseNotes@4
        displayName: 'Generate Release Notes'
        inputs:
          outputfile: '$(Build.BuildNumber).md'
          templateLocation: 'File'
          templatefile: 'xxxx-docs/templates/xxxxxx.md'
          dumpPayloadToConsole: false
          dumpPayloadToFile: false
          replaceFile: true
          getParentsAndChildren: false
          getAllParents: false
          getIndirectPullRequests: false
          checkstages: true
          failOnStderr: true
          wiqlSharedQueryName: Range 10500-10999/XXXX/XXXX
          checkForManuallyLinkedWI: true

I had to add XXX for a few sensitive Information, but I made sure the paths were correct.

[rfennell]

The WI returned by WIQL are placed in a special array (to avoid confusion with the primary ones associated automatically by the Azure DevOps API).

To access them use the follow handlebars

## List of WI returned by WIQL ({{queryWorkItems.length}})
{{#forEach queryWorkItems}}
*  **{{this.id}}** {{lookup this.fields 'System.Title'}}
{{/forEach}}

[Quallos]

Thank you! I think I had access issues, that I managed to get through. Now I have a template with the Workitems.

One other question is regarding the test harness.

I think there are also issues for accessing the Items (WIQL and WI in general)

The most common runtime reason for the task to fail is due API ECONNRESET issues. To avoid this failing the pipeline these will be treated as warnings and an attempt to generate any release notes possible
Error: Failed request: (401)
    at RestClient.<anonymous> (/Users/xxxx/RestClient.js:202:31)
    at Generator.next (<anonymous>)
    at fulfilled (/Users/xxxx/RestClient.js:6:58)
    at processTicksAndRejections (node:internal/process/task_queues:96:5) {
  statusCode: 401
}
Total Builds: [0]
Total Commits: [8]
Total Workitems: [10]
Total Related Workitems (Parent/Children): [0]
Total Release Tests: [0]
Total Tests: [0]
Total Manual Test Runs: [0]
Total Manual Test Configurations: [0]
Total Pull Requests: [0]
Total Indirect Pull Requests: [0]
Total Associated Test WI: [0]
Total Published Artifacts: [5]
Total Consumed Artifacts: [0]
Total WIQL Workitems: [0]
Writing payload data to file payload.json
Generating the release notes, the are 1 template(s) to process
##vso[task.debug]Using template mode File
Loading template file release-handlebars-template.md
##vso[task.debug]Loading handlebar template
##vso[task.debug]Processing template
##vso[task.debug]  WI: 0
##vso[task.debug]  CS: 8
##vso[task.debug]  PR: 0
##vso[task.debug]  Builds: 0
##vso[task.debug]  Manual Tests: 0
##vso[task.debug]  Manual TestConfigurations: 0
##vso[task.debug]  Release Tests: 0
##vso[task.debug]  Related WI: 0
##vso[task.debug]  Related Tests: 0
##vso[task.debug]  Indirect PR: 0
##vso[task.debug]  Consumed Artifacts: 0
##vso[task.debug]  Published Artifacts: 5
##vso[task.debug]  Query WI: 0
##vso[task.debug]Processing handlebar template
Loading handlebars-helpers extension
##vso[task.debug]An absolute path has not been provided for the customHandlebarsExtensionFolder, pre-pending the current working directory
##vso[task.debug]Attempting to load custom handlebars extension from /Users/cf07aa/Developer/ToySpace/AzurePipelines/Extensions/XplatGenerateReleaseNotes/XplatGenerateReleaseNotesTask/testconsole/.\testconsole/customHandlebars.js}
##vso[task.debug]Custom handlebars extension file does not exist
Completed processing template
Writing output file output.md
Finished writing output file output.md
Output variable 'no available in this tool'

Output:

List of User Stories in this Release (0)

List of Tasks in this Release (0)

List of Commits for this Release

-> This part works. All commits are listed

My settings:

{
    "TeamFoundationCollectionUri":"<>",
    "TeamProject":"<>",
    "buildId":"<>",
    "releaseDefinitionId":"",
    "releaseId":"",
    "environmentName":"windows", --> should I use mac here? since I am working on a mac
    "templatefile":"release-handlebars-template.md",
    "outputfile":"output.md",

    "dumpPayloadToConsole": "false",
    "dumpPayloadToFile": "true",
    "dumpPayloadFileName": "payload.json",

    "templateLocation": "File",
    "inlinetemplate": "",
    "outputVariableName": "no available in this tool",
    "showOnlyPrimary": "false",
    "replaceFile": "true",
    "appendToFile": "false",
    "getParentsAndChildren": "true",
    "getAllParents": "true",
    "searchCrossProjectForPRs": "true",
    "stopOnRedeploy": "false",
    "SortWi": "false",
    "SortCS": "false",
    "customHandlebarsExtensionCodeAsFile": "",
    "customHandlebarsExtensionCode": "",
    "customHandlebarsExtensionFile": "customHandlebars.js",
    "customHandlebarsExtensionFolder": ".\\testconsole",
    "overrideStageName": "",
    "checkStage": "false",
    "Fix349": "true",
    "tags": "",
    "overrideActiveBuildReleaseId":"<>",
    "overrideBuildReleaseId": "",
    "getIndirectPullRequests": "false",
    "considerPartiallySuccessfulReleases": "false",
    "checkForManuallyLinkedWI": "false",
    "getPRDetails": "false",
    "getTestedBy": "false",
    "maxRetries": "20",
    "stopOnError": "true",
    "wiqlFromTarget": "WorkItems",
    "wiqlSharedQueryName": "<>"
}

This is how the handlebar template looks like now (I dont need to use the WIQL here anymore):

# Release Notes for v{{buildDetails.buildNumber}}
## Newest updates on <>

* **Branch**: {{buildDetails.sourceBranch}}
* **Tags**: {{buildDetails.tags}}
* **Completed**: {{buildDetails.finishTime}}

### List of User Stories in this Release ({{workItems.length}})

{{#forEach workItems}}
{{#if (eq (lookup this.fields 'System.WorkItemType') "User Story")}}

* **{{this.id}}**  {{lookup this.fields 'System.Title'}}
  {{/if}}
  {{/forEach}}

### List of Tasks in this Release ({{workItems.length}})

{{#forEach workItems}}
{{#if (eq (lookup this.fields 'System.WorkItemType') "Task")}}

* **{{this.id}}**  {{lookup this.fields 'System.Title'}}
  {{/if}}
  {{/forEach}}

### List of Commits for this Release

{{#forEach commits}}

* ** ID{{this.id}}**
  - **FileCount:** {{this.changes.length}}
    {{/forEach}}