mirror of
https://github.com/tweag/gomod2nix.git
synced 2024-11-08 19:49:12 +00:00
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
|
# Gomod2nix
|
||
|
|
Convert applications using Go modules -> Nix
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
From the Go project directory execute:
|
||
|
|
``` bash
|
||
|
|
$ gomod2nix
|
||
|
|
```
|
||
|
|
|
||
|
|
This will create `gomod2nix.toml` that's used like so
|
||
|
|
``` nix
|
||
|
|
let
|
||
|
|
pkgs = import <nixpkgs> {
|
||
|
|
overlays = [
|
||
|
|
(self: super: {
|
||
|
|
buildGoApplication = super.callPackage ./builder { };
|
||
|
|
})
|
||
|
|
];
|
||
|
|
};
|
||
|
|
in pkgs.buildGoApplication {
|
||
|
|
pname = "gomod2nix-example";
|
||
|
|
version = "0.1";
|
||
|
|
src = ./.;
|
||
|
|
modules = ./gomod2nix.toml;
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## FAQ
|
||
|
|
|
||
|
|
### Why not continue work on vgo2nix?
|
||
|
|
Vgo2nix was built on top of the old Nixpkgs build abstraction `buildGoPackage`, this abstraction was built pre-modules and suffered from some fundamental design issues with modules, such as only allowing a single version of a Go package path inside the same build closure, something that Go itself allows for.
|
||
|
|
|
||
|
|
We need a better build abstraction that takes Go modules into account, while remaining [import from derivation](https://nixos.wiki/wiki/Import_From_Derivation)-free.
|
||
|
|
|
||
|
|
### Will this be included in Nixpkgs
|
||
|
|
|
||
|
|
Yes. Once the API is considered stable.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE)
|
||
|
|
file for details.
|