feat: automated javadoc generation with artifact upload

[n-o-u-r-h-a-n]

Context

AI/ai-sdk-java-backlog#329.

Implemented a workflow which could be used for automatic javadoc generation by artifact upload.
Here is the link to the successful continuous integration run where I tested the new workflow (javadoc.yaml) by calling it inside continuous integration.

Feature scope:

• Added the new workflow file named javadoc.yaml
• Integrated javadoc.yaml inside prepare-release workflow as well as perform release to create a PR with uploaded Aggregated JavaDoc artifact and update the JavaDocs on the documentation portal upon each version release of the SDK.

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]

The overall approach of using the bash script maybe is a very good alternative to using the plugins we had before. But I think to make it easier to maintain in the future we should add way more explanatory comments about what is actually happening.
Besides that I found some things worth checking but like the overall approach!

[Jonas-Isr]

This looks good :)

What is now missing is to call this workflow from the prepare-release workflow and to upload the generated files into our docs. For that we need

1. an additional step in your new workflow to create a PR on the AI SDK docs repo with the newly created javadocs. This will be very close to what happens also in the same workflow of the Cloud SDK,
2. an additional step in the prepare-release workflow to call your new workflow. This should be very similar to how this is called in the same workflow of the Cloud SDK repo,
3. a note in the PR created in the prepare-release workflow that the new javadoc PR needs to be reviewed and approved (exactly like in Cloud SDK),
4. two additional steps in the perform release workflow to merge the new javadoc PR. This should be very similar to how this is done in Cloud SDK here and here.

This looks like a long list but it should be very close to what happens already in the Cloud SDK.

[n-o-u-r-h-a-n]

This looks good :)

What is now missing is to call this workflow from the prepare-release workflow and to upload the generated files into our docs. For that we need

1. an additional step in your new workflow to create a PR on the AI SDK docs repo with the newly created javadocs. This will be very close to what happens also in the same workflow of the Cloud SDK,
2. an additional step in the prepare-release workflow to call your new workflow. This should be very similar to how this is called in the same workflow of the Cloud SDK repo,
3. a note in the PR created in the prepare-release workflow that the new javadoc PR needs to be reviewed and approved (exactly like in Cloud SDK),
4. two additional steps in the perform release workflow to merge the new javadoc PR. This should be very similar to how this is done in Cloud SDK here and here.

This looks like a long list but it should be very close to what happens already in the Cloud SDK.

Do I need to update documentation and release notes?

[Jonas-Isr]

Do I need to update documentation and release notes?

Yes, good idea! How about a line like "- Aggregated JavaDocs are published now on our documentation portal" under Improvements?

[Jonas-Isr]

Only very minor points!

[n-o-u-r-h-a-n]

Do I need to update documentation and release notes?

Yes, good idea! How about a line like "- Aggregated JavaDocs are published now on our documentation portal" under Improvements?

Sounds nice! I added it!

[Jonas-Isr]

Nice!