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 #252

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.

tobbbles commented 1 year ago

@aeneasr 🤦 I messed up and nuked the old pull request #249 on accident; my mistake!

I've updated the generator in this PR to 6.2.1 so it picks up the improved documentation changes in https://github.com/OpenAPITools/openapi-generator/pull/13478

I'd suggest tracking and updated to 6.3.0 in a future PR that targets specifically #229

aeneasr commented 1 year ago

Awesome 👍 :)