-
Notifications
You must be signed in to change notification settings - Fork 1.8k
doc: Add an auto-generated dependency graph for internal crates #19280
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
base: main
Are you sure you want to change the base?
Conversation
| ## Dependency Graph for Workspace Crates | ||
|
|
||
| <!-- | ||
| Below is an embedded .svg file, with interactive functionalities like drag/zoom-in/etc. |
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.
AI disclosure:
This snippet is to embed the deps.svg inside the markdown, and be able to drag/zoom. The implementation is AI generated, I have skimmed through it and it looks good to me, though I don't have enough front-end knowledge to inspect it in details.
datafusion/ci-dummy/Cargo.toml
Outdated
| # under the License. | ||
|
|
||
| [package] | ||
| name = "datafusion-ci-dummy" |
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.
For CI testing:
- Generated the dep graph
- Added this new dummy workspace member crate
Now the dep graph is obsolete, the CI should fail
If failed as expected in https://github.com/apache/datafusion/actions/runs/20129195011/job/57766134500?pr=19280
Co-authored-by: Martin Grigorov <[email protected]>
.github/workflows/dependencies.yml
Outdated
| with: | ||
| submodules: true | ||
| fetch-depth: 1 | ||
| - name: Setup Rust toolchain |
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.
I wonder if we should just run this script as part of some other job and save having to check out the code again...
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.
I agree, it's better to let it generate and deploy through CI automatically. Done in 307119c
Perhaps we should also do so for other auto-generated document sections, like configuration and function docs?
Which issue does this PR close?
Rationale for this change
A dependency graph for workspace member crates are often needed when doing refactors, I want it to be included in the doc, and have a script to update it automatically.
Here is the preview:

What changes are included in this PR?
deps.svg, and verify if the existing one is up to date.Contributor Guideto show this graphAre these changes tested?
I tested the dependency graph display locally, see above.
Is it possible to see the preview from this PR's change online?
I also included a dummy crate in the initial commit, to test if the CI can catch it and throw understandable error message.
Are there any user-facing changes?
No