Can Changelog link to the PR?

[rebeccafae]

In the changelog, can it link to the PR that made the change? It would make it a lot easier to find some of these to better see the impact it is having.

[pirj]

I support the idea for all our repos @rubocop/rubocop-rspec WDYT?

[bquorning]

I like the idea too. The main downside is that you don’t know the PR number when you write the changelog entry. It would be more efficient maybe to add the links right before releasing a new version?

[rebeccafae]

I like the idea too. The main downside is that you don’t know the PR number when you write the changelog entry. It would be more efficient maybe to add the links right before releasing a new version?

You don't? Doesn't the line get added in the same PR as the change, like in this one? #99

I haven't contributed here so I don't know, just curious based on what I thought the process was.

[bquorning]

Yes, the changelog lines get added in each PR. What I meant was that the contributor don’t know the number of the PR until it’s opened, which is after they push their code. So if we require the PR number to be in the changelog before we can merge a PR, each contributor has to push to their branch twice: Once before opening the PR and (at least) once after opening the PR.

What I’m saying is that I would very much like to still be able to make one-push pull requests.

Update: Just to be clear, I like the idea, and I often find myself navigating from the RuboCop changelog to a code search to find the PR where code was introduced. Your suggestion would make that so much easier. We just need to figure out how to do it efficiently, and not put an extra burden on contributors.

[r7kamura]

I also feel the desire to follow the PR links from the changelog.

Instead of manually writing changes in CHANGELOG.md, I am considering that it would be good to migrate to GitHub Releases and utilize the automatically generated release notes.

• https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

This would reduce the burden on those creating PRs compared to before, and also solve other problems such as CHANGELOG.md frequently causing conflicts.