Project cleanup (Fed JVM is an officially supported Apollo OSS project)

[hwillson]

This project has had an interesting history; it was originally created to address Apollo's own specific infrastructure needs, but has since grown into a reliable and effective way to work with Federation 1/2 on a JVM. While the library itself has grown, the supporting OSS infrastructure for this project has not, since this project was not staffed as an official Apollo OSS project. This has changed, meaning Federation JVM now has a team behind it. To reflect this, we need to make several changes to this project and repo to bring it up to Apollo OSS standards. We'll use this issue to track the needed changes at a high level, breaking more specific todos out into separate issues.

Things that need to happen:

• [cleanup] Update project documentation #178
• [cleanup] Update CI/CD infrastructure #179
• [cleanup] Update build process and project structure #180
• [cleanup] Create documentation on Apollo doc portal #181
• Example(s) that show how to use Federation JVM #182
• Public API tracking with japicmp? (or something else?)
• Agree on codestyle
• Improve test coverage and functionality
• Add ROADMAP.md
• Drop RELEASE_NOTES.md in favor of using Github Release

[setchy]

Awesome @hwillson. Could I add a +1 for adding a CHANGELOG.md and ROADMAP.md please 🙏

[martinbonnin]

+1 for ROADMAP.md 👍

For CHANGELOG.md, there is RELEASE_NOTES.md, did you want to change the name (I remember something about renovate maybe? 👀 ) ? Or more details in there?

[setchy]

Ah, my bad @martinbonnin - I overlooked RELEASE_NOTES.md. Renovate can handle this, but perhaps a rename to make it consistent with apollographql/federation, apollographql/apollo-server, apollographql/rover etc wouldn't hurt

[martinbonnin]

a rename to make it consistent with apollographql/federation, apollographql/apollo-server, apollographql/rover etc wouldn't hurt

Works for me 👍

[dariuszkuc]

Instead of using separate RELEASE_NOTES.md/CHANGELOG.md files we will be using standard Github Releases as it will contain the same information.

[hwillson]

Thanks to @dariuszkuc a lot of this work is now done! 🎉 We'll close this task off, and continue tracking the remaining items in separate issues.

[setchy]

Yes, huge thank you @dariuszkuc 👏