ory / sdk

The place where ORY's SDKs are being auto-generated
Apache License 2.0
139 stars 86 forks source link

docs: elixir - Publish documentation in release script #249

Closed tobbbles closed 1 year ago

tobbbles commented 1 year ago

Currently, we only publish the package contents to hex.pm, and no documentation.

According to hex publishing documentation https://hex.pm/docs/publish#documentation - we can publish both package and documentation by omitting the package part of the hex.publish command.

Elixir has a really nice online documentation platform under https://hexdocs.pm. By publishing the package and documentation, users will be able to read the generate documentation online, (e.g. at https://hexdocs.pm/ory_kratos/)

Related Issue or Design Document

Checklist

Further comments

This should work out of the box, as aeneasr already owns the packages on hex.

aeneasr commented 1 year ago

Ah, I remember why I did this, there was some problem with the release step when we published docs. I don't quite remember what it was though ...

tobbbles commented 1 year ago

I believe we wanted the upstream generator to fix it's elixir dependencies, which got cherry picked from https://github.com/OpenAPITools/openapi-generator/issues/12484

Looks to me like this got improved a lot in openapi-generator version v6.0.1 (https://github.com/OpenAPITools/openapi-generator/releases/tag/v6.0.1)

So perhaps this is blocked until upgrading of the generator. What are your thoughts?

tobbbles commented 1 year ago

Furthermore, v6.3.0 should be coming soon in the future, which will include changes for fixing #229

aeneasr commented 1 year ago

Ah, sounds awesome, looking forward to 6.3.0. Should we wait for the release to merge this PR?