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

Closed
wants to merge 0 commits into from

Conversation

tobbbles
Copy link
Contributor

@tobbbles tobbbles commented Jan 23, 2023

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 tobbbles changed the title Elixir: Publish documentation in release script docs: Elixir - Publish documentation in release script Jan 23, 2023
@tobbbles tobbbles changed the title docs: Elixir - Publish documentation in release script docs: elixir - Publish documentation in release script Jan 23, 2023
@aeneasr
Copy link
Member

aeneasr commented Jan 26, 2023

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
Copy link
Contributor Author

tobbbles commented Jan 26, 2023

I believe we wanted the upstream generator to fix it's elixir dependencies, which got cherry picked from OpenAPITools/openapi-generator#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
Copy link
Contributor Author

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

@aeneasr
Copy link
Member

aeneasr commented Jan 26, 2023

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

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