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

Better build + instructions for automated openapi docs #436

Closed
cholmes opened this issue Apr 22, 2019 · 3 comments
Closed

Better build + instructions for automated openapi docs #436

cholmes opened this issue Apr 22, 2019 · 3 comments
Assignees
Milestone

Comments

@cholmes
Copy link
Contributor

cholmes commented Apr 22, 2019

Discussed on our call on April 22:

People have been directly editing the generated OpenAPI docs. We decided that ideally on dev we just have the fragments, and users can build the current state themselves locally. And master will generate them, and upload to stacspec.org (#434).

So this issue is to get the automated build process down to make sure people don't commit the generated openapi docs to dev, and that the process is done right for master (possibly check to make sure they are there, and also that they don't get edited manually).

@m-mohr
Copy link
Collaborator

m-mohr commented Apr 23, 2019

I don't think we can fluently manage that the master has generated files and dev hasn't. This will eventually lead to problems once we need to merge master into dev again (for whatever reason). We can probably manage that they are generated into gh-pages and then made available there per branch. But maybe others have scripts for that, which work that way.

@cholmes
Copy link
Contributor Author

cholmes commented Apr 23, 2019

Yeah, I wasn't sure if there'd be a way to do it, but thought we might come up with something clever. Short of that, I think at the least we could put up a CI test that prevents people from changing the generated docs - like don't accept the PR if it edits the autogenerated files.

@matthewhanson matthewhanson modified the milestones: 0.7.1, 0.8.0 Aug 15, 2019
@cholmes
Copy link
Contributor Author

cholmes commented Aug 18, 2019

Closing this, as I think Matt got this quite a bit better. We can open issues for other specific improvements.

@cholmes cholmes closed this as completed Aug 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants