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

OpenApi Spec pushed to open5e.readme.com and working as expected. #587

Open
augustjohnson opened this issue Oct 20, 2024 · 1 comment
Open

Comments

@augustjohnson
Copy link
Collaborator

Related to #586

Requirements

Given a reliable, accurate openapi spec, I would like a build step that runs with a deploy that pushes that spec to open5e.readme.com.

I would like for clear linkage between the readme.md file and the api docs on open5e.readme.com.

This MOSTLY exists today.
https://github.com/open5e/open5e-api/blob/staging/.github/workflows/rdme-openapi.yml

Considerations

It may be nice to have two distinct instances. One for api-beta.open5e.com and one for api.open5e.com. That's fairly optional, the drift between the two is usually small.

@augustjohnson
Copy link
Collaborator Author

This is currently breaking due to a fairly cryptic error.
https://github.com/open5e/open5e-api/actions/runs/11426719754/job/31789977171#step:4:8

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

No branches or pull requests

1 participant