Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve XplatGenerateReleaseNotes Get PR details performance #1587

Closed
M4sterG opened this issue Jan 25, 2024 · 2 comments · Fixed by #1588
Closed

Improve XplatGenerateReleaseNotes Get PR details performance #1587

M4sterG opened this issue Jan 25, 2024 · 2 comments · Fixed by #1588

Comments

@M4sterG
Copy link
Contributor

M4sterG commented Jan 25, 2024

Azure DevOps Extensions

Artifact PR Description

Is your feature request related to a problem? Please describe.

As stated in the docs keeping the getPRDetails option to true results in poor performance when generating release notes. In our projects there many repositories and a huge amount of PRs resulting in the pipeline task taking a lot of time. However we can't set this flag to false because we need the PR details in our release notes.

Describe the solution you'd like

We added two optional parameters (getPRDetailsRepositoryId, getPRDetailsRefName) in the task which are then passed to getPullRequests function and finally to the filter GitPullRequestSearchCriteria. We then tested locally our changes and observed a significant improvement in the performance of the function.

Describe alternatives you've considered

No response

Additional context

No response

@rfennell
Copy link
Owner

I will have a look at PR #1588, thanks for suggesting it

@rfennell
Copy link
Owner

PR #1588 looks fine, just added a bit more documentation. I will get it merged and it will be released as 4.14.x

rfennell added a commit that referenced this issue Jan 30, 2024
…#1587) (#1588)

* added optional parameter to improve "Getting associated PRs" step performance
* Update the documentation

---------

Co-authored-by: Gabriel Catalin Gherasim <[email protected]>
Co-authored-by: Richard Fennell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants