Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: elixir - Publish documentation in release script #252

Merged
merged 1 commit into from
Jan 26, 2023

Conversation

tobbbles
Copy link
Contributor

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

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

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

@tobbbles
Copy link
Contributor Author

tobbbles commented Jan 26, 2023

@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 OpenAPITools/openapi-generator#13478

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

@aeneasr
Copy link
Member

aeneasr commented Jan 26, 2023

Awesome 👍 :)

@aeneasr aeneasr merged commit b5ce825 into ory:master Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants