Generate docs and schema with github actions #115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR is ready for review. |
|
@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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.