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

Automatic generation of API docs #13

Open
1 task done
savetheclocktower opened this issue Dec 27, 2024 · 1 comment · May be fixed by #14
Open
1 task done

Automatic generation of API docs #13

savetheclocktower opened this issue Dec 27, 2024 · 1 comment · May be fixed by #14
Labels
enhancement New feature or request

Comments

@savetheclocktower
Copy link
Collaborator

Have you checked for existing feature requests?

  • Completed

Summary

New deployments of the docs are still showing the API documentation from 1.114.0. I vaguely understand how to fix this — pulsar and the other documentation sources are submodules, and once they're updated we can run the script to regenerate the docs — but it would be great if this could be automated.

What benefits does this feature provide?

Instead of our having to remember it (and open a PR and get someone to review it), we could make it the last step of our release automation.

Any alternatives?

Doing it manually! Which sucks.

Other examples:

This is a bit tricky because I believe it would involve a GitHub action that runs a script, then commits the new files back to the repo. But I'm pretty sure there's prior art for this somewhere.

@savetheclocktower savetheclocktower added the enhancement New feature or request label Dec 27, 2024
@confused-Techie
Copy link
Member

Great idea to add this into our release automation.
I'll take a look at what it might mean to add it in, but I have a feeling the format will likely be something similar to how we handle updating the Pulsar chocolatey version over in that repo. Meaning an issue with a specific label is created, and that triggers actions local to that repo, at which point it will leave us with a PR to still review, but if we find the process is stable and trust it, we could always allow it to be automatically merged. Or at the very least reviewing a single PR is still much easier than handling the whole thing manually.

@confused-Techie confused-Techie linked a pull request Dec 28, 2024 that will close this issue
@confused-Techie confused-Techie linked a pull request Dec 30, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants