Convert applications using Go modules to Nix expressions
Go to file
dependabot[bot] 872b63ddd2 build(deps): bump cachix/install-nix-action from 25 to 26
Bumps [cachix/install-nix-action](https://github.com/cachix/install-nix-action) from 25 to 26.
- [Release notes](https://github.com/cachix/install-nix-action/releases)
- [Commits](https://github.com/cachix/install-nix-action/compare/v25...v26)

---
updated-dependencies:
- dependency-name: cachix/install-nix-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-03-11 10:53:05 +00:00
.assets Add logos and acknowledgements of project sponsors 2022-08-25 23:07:29 +12:00
.github build(deps): bump cachix/install-nix-action from 25 to 26 2024-03-11 10:53:05 +00:00
builder Merge pull request #96 from martinbaillie/master 2023-02-27 13:54:07 +13:00
docs docs: update flake url 2023-09-13 08:24:13 +02:00
internal silence deprecated package warning 2023-11-14 09:17:40 +01:00
templates/app Call `templates/app/shell.nix` without `buildGoApplication` 2023-09-23 22:13:09 +01:00
tests Add test for repo using vendored modules 2022-08-24 15:01:08 +08:00
.envrc Add python test script 2020-12-03 16:23:39 +01:00
.gitignore Add package generation for non development packages 2022-06-14 05:15:43 +08:00
.mergify.yml add mergify 2023-11-14 09:18:28 +01:00
LICENSE Add README file 2020-12-03 16:23:39 +01:00
README.md Add clarification about Gomod2nix and it's relationship to Trustix 2022-08-25 23:10:07 +12:00
default.nix Remove generic builder expression 2022-09-02 16:14:39 +12:00
flake.lock use flake-utils input and also override it in the template 2023-09-13 08:44:51 +02:00
flake.nix use flake-utils input and also override it in the template 2023-09-13 08:44:51 +02:00
go.mod build(deps): bump github.com/sirupsen/logrus from 1.8.1 to 1.9.3 2023-11-14 08:30:46 +00:00
go.sum build(deps): bump github.com/sirupsen/logrus from 1.8.1 to 1.9.3 2023-11-14 08:30:46 +00:00
gomod2nix.toml bump gomod2nix.toml 2023-11-14 09:31:20 +01:00
main.go Change package name from github.com/tweag/gomod2nix to github.com/nix-community/gomod2nix 2022-08-28 06:33:04 +12:00
overlay.nix Merge pull request #116 from doronbehar/exposeVendor 2023-11-14 09:05:47 +01:00
shell.nix expose flake interface that does not rely on overlays 2023-09-13 08:24:13 +02:00

README.md

Gomod2nix

Convert applications using Go modules -> Nix

Usage

From the Go project directory execute:

$ gomod2nix

This will create gomod2nix.toml that's used like so

let
  pkgs = import <nixpkgs> {
    overlays = [
      (self: super: {
        buildGoApplication = super.callPackage ./builder { };
      })
    ];
  };
in pkgs.buildGoApplication {
  pname = "gomod2nix-example";
  version = "0.1";
  src = ./.;
  modules = ./gomod2nix.toml;
}

For more in-depth usage check the Getting Started and the Nix API reference docs.

Motivation

The announcement blog post contains comparisons with other Go build systems for Nix and additional notes on the design choices made.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About the project

The developmentent of Trustix (which Gomod2nix is a part of) has been sponsored by Tweag I/O and funded by the NLNet foundation and the European Commissions Next Generation Internet programme through the NGI Zero PET (privacy and trust enhancing technologies) fund.

NGI0 logo NLNet banner Tweag logo