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

Generate docs and schema with github actions #115

Merged
merged 12 commits into from
Jun 15, 2021
Merged

Conversation

oeway
Copy link
Contributor

@oeway oeway commented Jun 14, 2021

This PR uses github actions to generate both the docs and schema, the generated file will be stored in the gh-pages branch.

Why use CI to generate?

I think this should be a better approach compared to pre-commit hooks which rely on certain setup and won't work for edit made directly in github website. It is also nice to separate the true source code from the generated files into different branches.

@oeway
Copy link
Contributor Author

oeway commented Jun 14, 2021

This PR is ready for review.

Copy link
Member

@FynnBe FynnBe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very neat!

@oeway
Copy link
Contributor Author

oeway commented Jun 15, 2021

@FynnBe thanks for the review, these is an issue for running the generating json spec, if I enable the command, the CI fails said no module named bioimageio.spec..., but the wired thing is that the generate docs command runs without issue. Any idea?

Let's fix it in another PR

@oeway oeway merged commit afff3a4 into master Jun 15, 2021
@oeway oeway deleted the generate-docs-schema branch June 15, 2021 10:02
@FynnBe
Copy link
Member

FynnBe commented Jun 15, 2021

@FynnBe thanks for the review, these is an issue for running the generating json spec, if I enable the command, the CI fails said no module named bioimageio.spec..., but the wired thing is that the generate docs command runs without issue. Any idea?

Let's fix it in another PR

👍 I'll have a look at it soon

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

Successfully merging this pull request may close these issues.

2 participants