Move generating_json_schema to generate crate
#608
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
wkazmierczak
force-pushed
the
@wkazmierczak/move-generating-json-schema
branch
2 times, most recently
from
60a4526 to
e13c113
Compare
wkazmierczak
changed the title
generate crate
wkozyra95
reviewed
Jul 10, 2024
There was a problem hiding this comment.
Remove generate_docs and generate_json_schema from https://github.com/membraneframework/live_compositor/blob/master/build_tools/nix/package.nix#L64
.github/workflows/deploy_docs.yml
Outdated
| @@ -7,7 +7,7 @@ on: | |||
| paths: | |||
| - "docs/**" | |||
| - "schemas/**" | |||
| - "src/bin/generate_docs/**" | |||
| - "src/bin/generate/generate_docs/**" | |||
generate/Cargo.toml
Outdated
| @@ -7,9 +7,10 @@ license = "BUSL-1.1" | |||
| # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | |||
|
|
|||
| [dependencies] | |||
| live_compositor = { path = ".." } | |||
| live_compositor = { path = "..", features=["decklink"] } | |||
There was a problem hiding this comment.
Will this work for you if you run locally cargo clippy --allow-dirty --allow-staged --workspace --all-targets?
I assume it will fail on decklink compilation on macOS.
Verify that, but if I'm correct you will need to add feature to this crate that optionally enable feature on live_compositor crate. Similiar to https://github.com/membraneframework/live_compositor/blob/master/Cargo.toml#L22
wkazmierczak
force-pushed
the
@wkazmierczak/move-generating-json-schema
branch
from
587014f to
d279f56
Compare
wkazmierczak
force-pushed
the
@wkazmierczak/move-generating-json-schema
branch
from
d279f56 to
c8c388d
Compare
wkozyra95
approved these changes
Jul 10, 2024
| mod schema_parser; | ||
|
|
||
| fn main() { | ||
| pub fn generate_docs() { | ||
| tracing_subscriber::fmt().init(); |
There was a problem hiding this comment.
move that init outside to the main function
Comment on lines
13
to
15
| .parent() | ||
| .unwrap() | ||
| .join("docs/pages/api/generated"); |
There was a problem hiding this comment.
Suggested change
| .parent() | |
| .unwrap() | |
| .join("docs/pages/api/generated"); | |
| .join("../docs/pages/api/generated"); |
Comment on lines
81
to
83
| .parent() | ||
| .unwrap() | ||
| .join(format!("schemas/{}.schema.json", name)); |
There was a problem hiding this comment.
Suggested change
| .parent() | |
| .unwrap() | |
| .join(format!("schemas/{}.schema.json", name)); | |
| .join(format!("../schemas/{}.schema.json", name)); |
wkazmierczak
force-pushed
the
@wkazmierczak/move-generating-json-schema
branch
from
c8c388d to
377746c
Compare
wkazmierczak
force-pushed
the
@wkazmierczak/move-generating-json-schema
branch
from
377746c to
4f6d13b
Compare
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.
Move generate_json_schema and generate_docs to
generatecrate.Substitute commands responsible for generating json schema and docs with one command
cargo run generate_from_type- it updates both docs and schema. Run with--checkchecks if json schema hasn't changed.