date_formatter module not working

[alvinvinalon]

We are using the latest version of this extension and the task fails on generating the file whenever we use date_formatter.

##[error]Error Processing handlebars [Error: Missing helper: "date_formatter"]

We have this version installed: 3.65.2 (Latest)

Is there anything we need to configure in Azure devops to load the date_formatter module?
Also, the example usage looks like it's missing a mustache
/* Usage
{{date_formatter buildDetails.startTime}
*/

should it be {{date_formatter buildDetails.startTime}} ?

Anyway, even after using {{date_formatter buildDetails.startTime}}, the date_formatter doesn't work and the file doesn't get generated.

Cheers

[rfennell]

A detailed in the WIKI you have to tell the task where custom extension is stored. This can be inline or a file

Finally there is also support for your own custom extension libraries. These are provided via an Azure DevOps task parameters holding either a block of JavaScript or the path to filename containing the JavaScript which is loaded into the Handlebars templating engine.

Either as inline javaScript

Note: Inline JavaScript can be entered in the YAML as a single line or a multi-line parameter as follows using the | operator

- task: XplatGenerateReleaseNotes@3
   inputs:
      outputfile: '$(Build.ArtifactStagingDirectory)\releasenotes.md'
      # all the other parameters required
      customHandlebarsExtensionCode: |
         module.exports = {foo() {
            return 'Returns foo';
        }};

Or the custom extension can be passed as file

 - task: XplatGenerateReleaseNotes@3
    inputs:
      outputfile: '$(Build.ArtifactStagingDirectory)\releasenotes.md'
       # all the other parameters required
       customHandlebarsExtensionFile: $(System.SourceDirectory)\customcode.js

Either way it can be consumed in a template as shown below

 ## To confirm our custom extension works
 We can call our custom extension {{foo}} 

[jamers99]

Very sorry, forgot to mention the error.

Generating the release notes, the are 1 template(s) to process
Loading template file C:\A\Utility\w\158\s\azure-pipelines\templates\deploy\release-notes\template.html
Loading handlebars-helpers extension
##[error]Error Processing handlebars [Error: Missing helper: "count_workitems_by_type"]
##[error]Error Processing handlebars [Error: Missing helper: "count_workitems_by_type"]
##[error]Error Processing handlebars [Error: Missing helper: "count_workitems_by_type"]

[jamers99]

Interesting, just tried it with the inline, and that worked! Seems like a bug? I double checked my path too.

- task: XplatGenerateReleaseNotes@3
    inputs:
      ...
      customHandlebarsExtensionCode: |
        module.exports = {count_workitems_by_type(array, typeName) {
            return array.filter(wi => wi.fields['System.WorkItemType'] === typeName).length;}
        };
      customHandlebarsExtensionFile: 
      ...

[rfennell]

Does the task log show it is finding and loading your custom module?

If you are using a self hosted agent it is worth checking the file is really where you think it is.

I do all my local testing using a custom module file, so if there is a bug it is a strange on as this code is well tested

[jamers99]

The only output I see is Loading handlebars-helpers extension which I include in the error log above. It would be helpful if it showed an error when it failed to load the extension file.

Since there is no error, I can't see the exact path it's trying to read, but I know my template path works, so if I go to the common root folder on the Agent machine, the js file is there along with the template.

[rfennell]

I checked the code and it should all be logged (assuming you have system.debug=true or the diag checkbox set). You should see

Attempting to load custom handlebars extension from ${filePath}}
then either
Loaded handlebars extension file
or
Custom handlebars extension file is empty

If you don't see one of the last two messages it means it can't find the file

The logic is in https://github.com/rfennell/AzurePipelines/blob/main/Extensions/XplatGenerateReleaseNotes/V3/ReleaseNotesFunctions.ts ln 980 if you want to see it.