Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thiagokokada/graalvm-nix
GraalVM derivations to be used by projects
https://github.com/thiagokokada/graalvm-nix
flake graalvm graalvm-native-image nix nixpkgs
Last synced: 2 months ago
JSON representation
GraalVM derivations to be used by projects
- Host: GitHub
- URL: https://github.com/thiagokokada/graalvm-nix
- Owner: thiagokokada
- License: mit
- Created: 2021-10-21T14:50:42.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-27T22:34:19.000Z (about 3 years ago)
- Last Synced: 2024-10-12T00:05:48.726Z (3 months ago)
- Topics: flake, graalvm, graalvm-native-image, nix, nixpkgs
- Language: Nix
- Homepage:
- Size: 81.1 KB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GraalVM derivations for Nix
## Introduction
This repository include multiple versions of GraalVM Community Edition (also
known as `graalvm-ce`) that are not available on
[nixpkgs](https://github.com/NixOS/nixpkgs) itself for some reason.
For example, nixpkgs generally includes only one version of GraalVM, often the
latest version. However it can also lag compared to upstream thanks to issues
that comes when bumping GraalVM and all packages that depends on it. This
repository in comparison has no such limitations, and may include multiple
versions of GraalVM when it does make sense.
Also, it is a ground for experimentation before upstreaming some changes. For
example, this repository includes `musl` variations of GraalVM derivations,
allowing for true static binaries (as oposed of using `--static` flag with
`glibc`). This is still not upstreamed since the solution is far from ideal. See
this [issue](https://github.com/NixOS/nixpkgs/issues/142392) for details.
Finally, another advantage is that everything is encapsulated into Flakes,
making it very easy to run ad-hoc. For example, using `nix run
"github:thiagokokada/graalvm-nix"` is sufficient to have a `musl` compatible
version of `native-image` for `graalvm11-ce`. See [usage](#usage-flakes) for
details.
## Usage (Flakes)
Assuming you have `nix` already installed:
```sh
# Not necessary if you're already are using nixUnstable
$ nix-shell -p nixUnstable
$ nix build --experimental-features 'nix-command flakes' "github:thiagokokada/graalvm-nix"
```
This will generate a `result` directory with the `graalvm11-ce` derivation with
`glibc` support by default. For example, you can find the GraalVM binaries on
`result/bin`.
You can edit your `/etc/nix/nix.conf` or `~/.config/nix/nix.conf` file and
add the following line to avoid having to pass `--experimental-features` flag
every time:
```ini
experimental-features = nix-command flakes
```
From here on this guide will assume the above configuration is done for brevity.
If you want `graalvm11-ce` with `glibc` support, you can use:
```sh
$ nix build "github:thiagokokada/graalvm-nix#graalvm11-ce"
```
If you want `graalvm17-ce` with `musl` support instead, you can use:
```sh
$ nix build "github:thiagokokada/graalvm-nix#graalvm17-ce-musl"
```
This Flake also export GraalVM binaries as apps to be used with `nix run`. For
example:
```sh
$ nix run "github:thiagokokada/graalvm-nix"
```
Will run `native-image` for the latest supported version of `graalvm11-ce` with
support for `glibc`. This is equivalent to:
```sh
$ nix run "github:thiagokokada/graalvm-nix#11/glibc/latest/native-image"
```
If you want `graalpython` on `graalvm17-ce` `21.2.0` instead with `musl`:
```sh
$ nix run "github:thiagokokada/graalvm-nix#17/musl/21_2_0/graalpython"
```
Or if you want `ruby` `graalvm11-ce` `21.3.0` with `musl`:
```sh
$ nix run "github:thiagokokada/graalvm-nix#11/musl/21_3_0/ruby"
```
If you want to check a list of all available apps, see `resources/bin-names.nix`
file.
Keep in mind `musl` variations only works on Linux, and also only makes sense if
you want to use `native-image --static --libc=musl`. Otherwise both variations
should be equal. You should use non-musl variations on macOS.
## Example
See [this PR](https://github.com/thiagokokada/babashka/pull/1) for an example on
how to convert a non-trivial GraalVM native-image application
([Babashka](https://github.com/babashka/babashka/)) to use this repository
instead.
## Known issues
`musl` variations must have the `--libc=musl` flag passed to `native-image`,
otherwise the build will fail with linking errors.
`irb` on GraalVM 21.3.0 is broken on all platforms.