-
Notifications
You must be signed in to change notification settings - Fork 43
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
[DOC] Auto-generate openapi.json #782
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
✅ Deploy Preview for kaleidoscopic-dango-0cf31d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for conda-store canceled.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quick question: this will make a PR against the branch that someone is trying to merge, right? So the workflow looks like this:
- I make a PR
- This action runs, updating
openapi.json
. A PR against my branch is opened. - I merge the PR to my branch
- Then I merge my branch to
main
Is that the workflow?
If I've got that workflow right, I'd vote to have a different workflow similar to how pre-commit.ci
works:
- I make a PR
- This action runs, updating
openapi.json
. A commit to my branch is made. - I merge my branch to
main
But that's just my preference.
Thanks for the review!
@peytondmurray No, this workflow opens a PR against |
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
So my one problem with this is that doc versions that track the |
That's fair. The docs are currently only built against I didn't want to generate the file on every merge to main because not all PRs affect the API. I think we can re-generate this on updates to certain files. I'm not sure which specific files to track here, but I can update the PR to regenerate |
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Ref: #766
Description
This pull request:
openapi.json
static file. This file is used to generate the REST API docs.conda-store.sqlite
to.gitignore
Pull request checklist
Additional information
How to test
I've tested it on my fork: pavithraes#4