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

PR lookup detection in CHANGELOG generation is not working as expected #5148

Closed
rashmigottipati opened this issue Aug 16, 2021 · 3 comments
Closed
Milestone

Comments

@rashmigottipati
Copy link
Member

rashmigottipati commented Aug 16, 2021

Bug Report

Generating the CHANGELOG from the fragments may result in some lines pointing to incorrect PR links.

For the 1.11.0 release, the release notes https://github.com/operator-framework/operator-sdk/releases/tag/v1.11.0 have three additions and changes that have incorrect PR links. Below are the changes that have incorrect PR links:

All those three changes reference the PR #4863, however the PR that resulted in those changes is #5117.

In most cases, the PR lookup detection works just fine and as expected. In this particular case, it's possible that the PR lookup is getting confused as #4863 and #5117 begin with the same name and contain similar words, however, the proper resolution would be that the PR lookup algorithm should purely be based on finding the right fragments and linking the PRs appropriately.

@rashmigottipati
Copy link
Member Author

We should also probably add a note to the release documentation for the release PR authors and approvers to do a manual check and make sure that the linked PRs in the release notes PR are all accurate.

@asmacdo asmacdo added this to the v1.12.0 milestone Aug 16, 2021
@asmacdo
Copy link
Member

asmacdo commented Aug 16, 2021

If we cant get this done by 1.12, lets do a manual audit to make sure the links are correct.
@jberkhahn

@jberkhahn jberkhahn modified the milestones: v1.12.0, v1.13.0 Sep 8, 2021
@asmacdo asmacdo modified the milestones: v1.13.0, v1.14.0 Sep 22, 2021
@jmrodri
Copy link
Member

jmrodri commented Oct 18, 2021

This hasn't happened in a while. I don't think it's worth keeping open.

@jmrodri jmrodri closed this as completed Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants