How the PRs merged work with generate release notes?

[n1vgabay]

@rfennell At the moment, I have a solid process regarding generating and publishing release note per each release.

What I want to understand is when I'm merging a PR from one branch to another, the generate release notes will work for me.
If after this release, i'll create another release straight after with the same artifact... I won't see the generated release notes (although it's in the same artifact).

Why is that?

[n1vgabay]

For example,
For 20241218-1, I'll get generated release notes, for 20241218-2, I won't get the generated release notes.

[rfennell]

@n1vgabay if you set the OverrideActiveBuildReleaseId parameter to 0 this will override the last good build used for the compare with 0 (or whatever buildID you pick as the oldest to conside). I think this should have the effect you desire.

Just be aware that release notes generation could be slow if there is a lot of history

[n1vgabay]

@n1vgabay if you set the OverrideActiveBuildReleaseId parameter to 0 this will override the last good build used for the compare with 0 (or whatever buildID you pick as the oldest to conside). I think this should have the effect you desire.

Just be aware that release notes generation could be slow if there is a lot of history

How can I set this parameter inside the extention via the Azure DevOps UI (not as yaml) ?

[n1vgabay]

I think I found it;

[n1vgabay]

@rfennell Looks like it's isn't working :(
Error shown below.

Btw,

• Can I remove the warning error the extention is added to the stage as "partially successful"?
  I can't mark the stage as not succeeded, stage must to be marked as fully success no matters aka (Green).

Hopfully I can get over this issue :((

The error:

2025-01-22T14:13:13.3602282Z Creating the credential handler from the OAUTH token
2025-01-22T14:13:13.6888928Z Using the override for the active release of ID '0'
2025-01-22T14:13:13.6893133Z Getting the current release details
2025-01-22T14:13:14.0088445Z Show associated items for primary artifact only is set to true
2025-01-22T14:13:14.0089008Z Getting the Environment Id
2025-01-22T14:13:14.0107695Z 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
2025-01-22T14:13:14.0131215Z TypeError: environments is not iterable
2025-01-22T14:13:14.0132193Z     at getReleaseDefinitionId (D:\Azure-Agents\Agent1\_work\_tasks\XplatGenerateReleaseNotes_7b0a5887-75c4-4ade-a915-f92a93c934cb\4.22.4\ReleaseNotesFunctions.js:94:29)
2025-01-22T14:13:14.0132698Z Total Builds: [0]
2025-01-22T14:13:14.0133172Z Total Commits: [0]
2025-01-22T14:13:14.0133781Z     at Object.<anonymous> (D:\Azure-Agents\Agent1\_work\_tasks\XplatGenerateReleaseNotes_7b0a5887-75c4-4ade-a915-f92a93c934cb\4.22.4\ReleaseNotesFunctions.js:1451:41)
2025-01-22T14:13:14.0134389Z     at Generator.next (<anonymous>)
2025-01-22T14:13:14.0135167Z     at fulfilled (D:\Azure-Agents\Agent1\_work\_tasks\XplatGenerateReleaseNotes_7b0a5887-75c4-4ade-a915-f92a93c934cb\4.22.4\ReleaseNotesFunctions.js:5:58)
2025-01-22T14:13:14.0135761Z     at processTicksAndRejections (node:internal/process/task_queues:96:5)
2025-01-22T14:13:14.0136170Z Total Workitems: [0]
2025-01-22T14:13:14.0136549Z Total Related Workitems (Parent/Children): [0]
2025-01-22T14:13:14.0136893Z Total Release Tests: [0]
2025-01-22T14:13:14.0137272Z Total Tests: [0]
2025-01-22T14:13:14.0139153Z Total Manual Test Runs: [0]
2025-01-22T14:13:14.0149781Z Total Manual Test Configurations: [0]
2025-01-22T14:13:14.0150313Z Total Pull Requests: [0]
2025-01-22T14:13:14.0355097Z Total Indirect Pull Requests: [0]
2025-01-22T14:13:14.0355642Z Total Associated Test WI: [0]
2025-01-22T14:13:14.0355924Z Total Published Artifacts: [0]
2025-01-22T14:13:14.0356216Z Total Consumed Artifacts: [0]
2025-01-22T14:13:14.0356496Z Total WIQL Workitems: [0]
2025-01-22T14:13:14.0356795Z Generating the release notes, the are 1 template(s) to process

[rfennell]

The call that is failing is trying to work out which environment you are running the task on

export function getReleaseDefinitionId(environments: ReleaseEnvironment[], environmentName: string): number {
    agentApi.logInfo(`Getting the Environment Id`);
    var environmentId: number = 0;
    for (let environment of environments) {
        if (environment.name.toLowerCase() === environmentName) {
            environmentId = environment.definitionEnvironmentId;
        }
    }
    if (environmentId === 0) {
        throw `Failed to locate environment with name ${environmentName}`;
    }
    agentApi.logInfo(`Identified [${environmentName}] as having id [${environmentId}]`);
    return environmentId;
}

Can see not why settings overrideBuildReleaseId to 0 shoudlhave any effect here as that parameter is not used until later in the logic.

What do you see after the Getting the Environment Id message in the log for your usual run?