Automate release notes

[Jonas-Isr]

Context

AI/ai-sdk-java-backlog#94

We need release notes now that we have an initial version publicly available. For this, I copied the way Cloud SDK is doing their release notes:

• There is now a release-notes.md file in under docs/release-notes. In a PR, you can add something to this file. This file functions as a collection of all release notes since the last (minor or major) release.
• (Once a new minor or major version is published) There is a file named release-notes-0-to-14.mdx under docs/release-notes that captures all the release notes since the last major release. After every 15 minor releases, a new file is used to not avoid making this file too long (the next files will then be called release-notes-15-to-29.mdx and so on).
• In the Prepare Release workflow, content from release-notes.md is copied to the appropriate release-notes-X-to-Y.mdx file. After the release version is created, a new (empty) release-notes.md is created for the next version.

Feature scope:

• GitHub release contains release notes (GA itself can be a one time manual job)
  • To make this work for the GA, we could add release note into release-notes.md.
• Process is automated (At least the step of collecting the release notes for the current release should be automated)
• Concept for how diff between latest release and current status can be viewed
  • This can be seen in the release-notes.md file.

Definition of Done

• Functionality scope stated & covered
• Tests cover the scope above
• Error handling created / updated & covered by the tests above
• Aligned changes with the JavaScript SDK
• Documentation updated
• Release notes updated

[Jonas-Isr]

Successful run in my fork: /~https://github.com/Jonas-Isr/ai-sdk-java-test/pull/16

[newtork]

(Comment/Suggestion)

I wonder whether this can be replaced with a regex.
such that we don't have to maintain the categories by hand in this python script.

[CharlesDuboisSAP]

It has never needed maintenance in the Cloud SDK, I think it's fine

[Jonas-Isr]

I am not experienced with regexes. Would that really be less maintenance effort than having an explicit list?

[Jonas-Isr]

Also note, that you can always add your own custom categories in release_notes.md and they will be copied. This here only ensures that no empty category (of the 4 suggested ones in the template) is copied over into the release_notes_X_to_Y files.