Configuration Options

Parameter	Type	Description
extensionmode	option	You can choose between the differen extension modes: 'rn = Release Note', 'ki = Knonwn Issue', 'uf = Upcoming Feature'. This determines the default process behavior of the build task.
entryKey	option	Define the existing entry from the Hub that will be synced and build. Only available in extension mode 'ki' and 'uf'
createEntry	boolean	true if a release note entry should be created in the hub; otherwise, false.
exportRepo	boolean	true if the entry should be exported to a specified repository.
title	string	The title to display in the entry.
version	string	Only needs to be specified if you want a version to be displayed for the entry.
description	string	Only needs to be specified if you want a description to be displayed for the entry.
placeholders	string	Only needs to fill the specified placeholder values. To overwrite or fill your placeholders add the following syntax in the textfield: [your_placeholder_name=value]. Multiple placeholders can be specified on separate lines or separated by a comma.
repository	string	The repository to which the entry should be exported. You can specify the ID or the name of the repository.
branch	string	The branch name that will be used to check the entry into the repository.
pushMode	option	The push mode determines how data is exported to the repository, offering three choices: 'Add' creates a new entry, 'Modify' appends the new entry to an existing file (versioning), and 'Replace' substitutes an existing file with the entry. Please note that this option operates based on the 'repoPath' parameter, which specifies the file path.
skipCI	boolean	Determines whether the commit should be marked with [skip ci]. This is useful if you want to avoid re-triggering the pipeline, especially if the trigger is the branch where the entry is committed.
language	picklist/string	To use the multilanguage feature define here a langauge code that should be build. Leave it empty to don't use multilanguage.
repoPath	string	The path to the entry document in the repository. NOTE: The path structure works with "/". For example, if you want to store the document in the entry folder, then enter entry/filename.md.

Multilanguage Best Use Case

To automate the entry geneartion multilingual, you need to create multiple tasks for each supported langauge. Turn of the "create entry" option excluded from the last. We recommend to use at last item, the langauge, that is your setuped defualt language in the settings. At the end it can look like this:

steps:
  - task: Changelogs-for-DevOps-Build-Task@4
    inputs:
      extensionmode: 'rn'
      exportRepo: true
      createEntry: false
      title: '$(Build.Repository.Name) Entry'
      version: '1.0.0'
      language: 'es'
      repository: '$(Build.Repository.Name)'
      branch: '$(Build.SourceBranchName)'
      pushMode: 'Add'
      repoPath: '/rfd/spanish/$(Build.Repository.Name) - $(Build.BuildNumber).md'

  - task: Changelogs-for-DevOps-Build-Task@4
    inputs:
      extensionmode: 'rn'
      exportRepo: true
      createEntry: false
      title: '$(Build.Repository.Name) Entry'
      version: '1.0.0'
      language: 'de'
      repository: '$(Build.Repository.Name)'
      branch: '$(Build.SourceBranchName)'
      pushMode: 'Add'
      repoPath: '/rfd/deutsch/$(Build.Repository.Name) - $(Build.BuildNumber).md'

  - task: Changelogs-for-DevOps-Build-Task@4
    inputs:
      extensionmode: 'rn'
      exportRepo: true
      createEntry: false
      title: '$(Build.Repository.Name) Entry'
      version: '1.0.0'
      language: 'ja'
      repository: '$(Build.Repository.Name)'
      branch: '$(Build.SourceBranchName)'
      pushMode: 'Add'
      repoPath: '/rfd/japanese/$(Build.Repository.Name) - $(Build.BuildNumber).md'

  - task: Changelogs-for-DevOps-Build-Task@4
    inputs:
      extensionmode: 'rn'
      exportRepo: true
      createEntry: true
      title: '$(Build.Repository.Name) Entry'
      version: '1.0.0'
      language: 'en'
      repository: '$(Build.Repository.Name)'
      branch: '$(Build.SourceBranchName)'
      pushMode: 'Add'
      repoPath: '/rfd/english/$(Build.Repository.Name) - $(Build.BuildNumber).md'

Placeholder Replacement

To change the value of existing placeholder you need to use the following syntax:

[your_placeholder_name=value]
[your_placeholder_name2=value2]

In a YAML pipeline this looks like this, after you have added the build task to your pipeline.

placeholders: |
    [your_placeholder_name=value]
    [your_placeholder_name2=value2]

The square brackets "[]" must remain, and as you can see, as in the example above, you can fill in more than one placeholder.

To replace the value of placeholder in a classic piepline you need to add them Please define these variables in the Pipeline Variables tab as shown.

Finalization of configuration

Once you have adjusted your configuration, you can add the build task to your pipeline using the Add button. The build task should be listed within the steps section. Here is an example of how to include it:

steps:
- task: Changelogs-for-DevOps-Build-Task@3
  inputs:
    extensionmode: 'rn'
    createEntry: true
    title: '$(Build.Repository.Name) Changelog'
    placeholders: |
      [productVersion=$(App_Version)]
      [buildDate=$(DateTime)]
    repository: '$(Build.Repository.Name)'
    branch: '$(Build.SourceBranchName)'
    pushMode: 'Add'
    repoPath: 'Changelog/$(Build.Repository.Name) - $(Build.BuildNumber).md'

Please check the permissions

To avoid problmens please make sure to set all required permissions!