Automatic updating of specification bound SDKs

[ariesclark]

Use the deployment API with GitHub Actions to have every language specific SDK automatically release new versions.
https://docs.github.com/en/rest/reference/repos#deployments

[Foorack]

@ruby It works!

How

This task in specification sent a repository_dispatch event to vrchatapi-javascript
https://github.com/vrchatapi/specification/actions/runs/1271138237

This then triggered an SDK build, which was then committed back into the source tree and finally pushed to NPM 🚀 🎉
https://github.com/vrchatapi/vrchatapi-javascript/runs/3704050810?check_suite_focus=true

It requires a user access token which has write-permissions in both repositories. Because I didn't want to use my personal account (bad idea for several reasons) I created a dummy account @VRCCat who's only purpose it is to trigger dispatch workflow events.

What's next

This was a proof-of-concept. I am currently working with hooking up all the repos to do this automatically at specification release.
Dart and vrcpy are out of scope due to different project setup.

Documentation

• GitHub repository_dispatch: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#manual-events
• The cross-repository access tricky, but this helped: https://blog.marcnuri.com/triggering-github-actions-across-different-repositories

[Foorack]

JavaScript/Node, Python, C# and Java have now been hooked up.

---

Rust will have to wait until release 5.3.0 of openapi-generator due to OpenAPITools/openapi-generator#10296.

Milestone: https://github.com/OpenAPITools/openapi-generator/milestone/38

[Foorack]

5.3.0 is now released, but has breaking regression for Rust.
This is now blocked by OpenAPITools/openapi-generator#10720 (see vrchatapi/vrchatapi-rust#1)

[Foorack]

Fixed as of 01ba01a

Currently using a custom-compiled version of openapi-generator for Rust specifically until they release a fixed version, e.g. 5.3.1.