redoc
redoc copied to clipboard
Redocly
Support for GitHub Actions
Hey, I have created a GitHub Action to execute redoc-cli commands: https://github.com/marketplace/actions/redoc-cli-github-action I really like what you're doing with redoc. I'm using this action in a side project to automatically generate the docs for a serverless REST API. Could this action be something for your repository here (e.g. use it in GitHub Actions to continuously showcase some examples) or would you like to link to it in the docs? If you're not interested, feel free to close this issue again. Cheers, Sebastian
Hey @seeebiii! This looks fantastic!
We were planning to create our "official" GitHub Action as part of this repo (under @redocly organization).
Would you be interested in contributing?
@RomanHotsiy Sure :-) How would you like to see my contribution? Should I transfer the repository to Redocly or what do you prefer?
Should I transfer the repository to Redocly
That would be awesome! Don't you mind if we make you an admin in this repo after you transfer it?
Also, I've noticed you're using some third-party redoc-cli docker image https://github.com/seeebiii/redoc-cli-github-action/blob/master/Dockerfile#L1
Just figured our there is no "official" redoc-cli image (https://github.com/Redocly/redoc/issues/1158) I'll fix this.
Also, could you explore the possibility to do javascript actions vs docker? https://help.github.com/en/actions/creating-actions/creating-a-javascript-action
Should I transfer the repository to Redocly
That would be awesome! Don't you mind if we make you an admin in this repo after you transfer it?
That's fine :-)
Also, I've noticed you're using some third-party redoc-cli docker image https://github.com/seeebiii/redoc-cli-github-action/blob/master/Dockerfile#L1
Just figured our there is no "official" redoc-cli image (#1158) I'll fix this.
Yes, I had to build my own. You can find the code in this repository: https://github.com/seeebiii/docker-redoc-cli But I just recognized right now that you also have a Dockerfile in your redoc-cli code which is similar to mine 😄
Also, could you explore the possibility to do javascript actions vs docker?
Sure, I'll have a look there. However, in this case I probably have to reuse a few lines from your redoc-cli code which is a bit more work than just creating a small Dockerfile like before ;-)
The big thing about Javascript Actions relative to Docker Actions is that Javascript Actions have no build time.
@melissarh57: Did this get published?
this feature might conflict with their business model. I don't think they will do it.
We were planning to create our "official" GitHub Action as part of this repo (under @Redocly organization).
has this been implemented? If so, can you please point us in the right direction?
Thanks for checking in! I don't have any news yet, but we'll keep this issue updated when we're working on it.
