Publish changelog notes under GH Releases

[setchy]

Would it be possible to begin publishing release notes for the federation packages?

This would make it easier for consumers to understand what are the non-breaking updates, and more importantly any potential breaking changes

[trevor-scheer]

Hey @setchy, there are CHANGELOG.mds within the federation and gateway subfolders where you can view these changes. Is the ask that these changes be published more formally via GH releases? I think this could be nice to implement.

[setchy]

Thanks @trevor-scheer - I'll pin that file.

That's correct - publishing them in the GH Releases is the feature request. For context, we use renovate-bot to automate dependency updates and it pulls release notes from GH and attaches them to our PRs.

[glasser]

Renovate does support CHANGELOG files, so we might just have some misconfiguration there. See renovatebot/renovate#4724

[glasser]

(and looks like the logic is in this file: https://github.com/renovatebot/renovate/blob/master/lib/workers/pr/changelog/release-notes.ts)

[glasser]

(We definitely have it set up properly for apollo-server, as you can see in the release notes section of #623)

[setchy]

Thanks @glasser. I can confirm that renovate is correctly pulling the PR change notes for apollo-server

[setchy]

I believe renovate is looking for the CHANGELOG.md at the root of https://github.com/apollographql/federation, which is why https://github.com/apollographql/apollo-server is working

For reference: renovate github changelog worker

[setchy]

Example of the most recent Renovate PR showing the difference between @apollo/gateway and apollographql/apollo-server

[setchy]

For those interesting: I believe Renovate issue renovatebot/renovate#10954 could be root of the inconsistent release note parsing with this repo

[setchy]

Monorepo handling now available with Renovate v29.30.0 - renovatebot/renovate#12543

However these two issues will prevent use of this enhancement

• @apollo/gateway and @apollo/subgraph missing recent changelog entries #1263
• @apollo/composition package missing CHANGELOG.md #1262

That said, going to close this issue

[setchy]

#1815 was recently raised to reexamine setting this up