-
Notifications
You must be signed in to change notification settings - Fork 88
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
chore: add a comprehensive dfx json reference #2361
chore: add a comprehensive dfx json reference #2361
Conversation
…ence-to-docs-site
I think building a separate github actions workflow that updates the JSON schema file will suffice, I'm not sure how having e2e test would then be useful. The workflow could run on each push for each PR, and do something along these lines:
The workflow could be made |
…site' of github.com:dfinity/sdk into SDK-287-add-a-comprehensive-dfx-json-reference-to-docs-site
.github/workflows/update-docs.yml
Outdated
@@ -0,0 +1,45 @@ | |||
name: Update Docs | |||
on: | |||
pull_request: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pull_request: | |
pull_request |
the :
is unnecessary here
~/.cargo/git | ||
target | ||
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} | ||
- name: Install Rust |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more of a fyi, cause I'm not 100% certain here (help @adamspofford-dfinity), but I think this step is unnecessary since we have rust-toolchain.toml
file - cargo should be able to use the correct version here
to verify, you might want to try rustc --version
instead and see if its 1.60.0
nvm, i see its there |
Co-authored-by: Marcin Nowak-Liebiediew <marcin.liebiediew@dfinity.org>
Description
Adds
dfx schema
, a command that prints the current schema fordfx.json
. Also added a workflow to keep a copy of the output up to date atdocs/dfx-json-schema.json
so that the docs can reference the current schema.First part of SDK-287
How Has This Been Tested?
docs/dfx-json-schema.json
is up to datedfx schema
produces valid jsonChecklist: