Repository navigation
Commit db83fcc
authored
feat: add Nix flake and direnv support (#26005)
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes #123` indicates that this PR will close issue #123.
-->
Happy to file an issue if needed!
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
Please explain the problem you are trying to solve in terms of the
user-visible
behavior, rather than the implementation.
For example, "The code in `foo.rs` doesn't handle nulls" is a symptom of
the
implementation. "COUNT(DISTINCT) returns wrong results when the column
contains
nulls" is the user-visible problem.
-->
DataFusion requires
[protobuf](https://datafusion.apache.org/contributor-guide/development_environment.html#protoc-installation)
and OpenSSL installations to compile. Existing instructions only cover
[FHS](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard)-compliant
systems.
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here, but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->
- Nix flake with protobuf, openssl, and pkg-config to avoid configuring
the paths manually
- Nix flake lockfile
- integration with https://github.com/nix-community/nix-direnv to
automatically load the flake when entering source code directory
## What is the testing strategy for this PR?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
Briefly describe how this PR is tested, and point to the specific tests
you added. For example: 'This new feature is covered by the
`sqllogictest` cases added in `foo.slt`'.
If this PR does not add tests, explain why. For example, if the change
is already covered by existing tests, please mention it.
You should also check the `codecov` bot reply on this PR to confirm the
changed code is exercised.
-->
I have confirmed DataFusion now successfully compiles without having
protobuf or OpenSSL installed globally. Would appreciate confirmation
that this also works for other Nix[OS] developers!
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
If there are any breaking changes to public APIs, please add the `api
change` label.
-->
No.
## Other considerations
I chose to track the stable
[channel](https://nixos.wiki/wiki/Nix_channels) to minimize the risk of
flake breaking. I chose to check-in the flake lock for reproducibility -
note that this means it will need to be periodically bumped.
This flake could be further extend to include other "supporting"
packages that DataFusion relies on for development, such as `uv` --
omitted those for simplicity of the PR / to not have to decide what goes
into flake VS not _now_.
I appreciate this is yet another developer-facing file that needs to be
maintained, and the project already has a devcontainer setup. However,
this provides a quick start for all developers using Nix[OS], without
forcing them to accept overhead of a Docker container, or figuring out
the native libraries installation themselves.
If nothing else -- every time I `git clone` a project that has flake +
direnv integration and automatically sets up a [Nix
shell](https://nixos.wiki/wiki/Development_environment_with_nix-shell)
that "just works", it makes my day a little bit and makes me that much
more likely to consider contributing. :) I want the same experience for
all (future) DataFusion contributors out there!1 parent 6f3f7b7 commit db83fcc
4 files changed
Lines changed: 94 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
72 | 76 | | |
73 | 77 | | |
74 | 78 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
0 commit comments