No build detected with checkStage to true

[misecca]

I want to to generate a changelog between a tag and the current build.

Follow the wiki I set:

• checkStage: true
• tags: 0.3.6 (just an example)

My azure pipeline is triggered manually with two stages:

• first stage build the application
• second stage calculate the change log

I use the version 3 of XplatGenerateReleaseNotes

This is the task

- task: XplatGenerateReleaseNotes@3
   inputs: 
     tags: '0.3.6'
     checkStage: true
     templatefile: 'xxx/change-log-template.md'
     outputfile: 'xxx/changelog.md'
     outputVariableName: 'outputvar'
     templateLocation: 'File'  
     dumpPayloadToFile: True
     dumpPayloadFileName: xxx/payload.json
     dumpPayloadToConsole: false        
     replaceFile: True
     appendToFile: True
     getParentsAndChildren: True
     getAllParents: True
     getIndirectPullRequests: False
     stopOnError: False
     considerPartiallySuccessfulReleases: False
     checkForManuallyLinkedWI: False  

From log I see:

Getting the current build details
Only considering builds with the tag(s) '0.3.6'
Getting items associated the builds since the last successful build to the stage 'ChangeLog'
Found '3' matching builds to consider
Matching 'successful' builds only
Comparing 1346710 against 1346710
Ignore compare against self
Comparing 1346680 against 1346710
Skipping build as does not have the correct tags
Comparing 1346675 against 1346710
Skipping build as does not have the correct tags
There has been no past successful build for this stage, we need to get the details for all past builds
Using workaround for build API limitation (see issue #349)

The result is that I made a comparison among all the previous build and the current one.

I use the same XplatGenerateReleaseNotes@3 with checkStage set to false and it work correctly (in this case the pipeline is triggered automatically when I push on main)

[rfennell]

The task does not support generating a changelog between a tag and the current build. It can only tags for filtering historic build runs, as it doing. So to explain what is occurring:

1. The task iterates back across a list of past pipeline runs

2. It first checks that they the requested tag (skipping them if they do not)

3. if the tag matches it then looks to see of the current stage is

   • present in the run
   • was successful

   If both these criteria are matched then this is used as the base run to compare against.

If you want to compare against some historic run have a look at #1557 as it discusses exactly that problem and provides a solution