Merge remote-tracking branch 'juan/add-version-to-nix-builds'

Author: acaloiaro

.envrc

@@ -1,13 +1,10 @@
-if ! has nix_direnv_version || ! nix_direnv_version 2.2.1; then
-  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/2.2.1/direnvrc" "sha256-zelF0vLbEl5uaqrfIzbgNzJWGmLzCmYAkInj/LNxvKs="
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
+  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
 fi
 
 watch_file flake.nix
-watch_file flake.lock
-watch_file go.lock 
 
-if ! use flake . --impure
+if ! use flake .
 then
-  echo "devenv could not be built. The devenv environment was not loaded." >&2
+  echo "development shell could not be built. The nix environment was not loaded." >&2
 fi
-

.github/workflows/goreleaser.yml

@@ -20,15 +20,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: install nix 
+      - name: install nix
         uses: cachix/install-nix-action@v31
         with:
           github_access_token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: cachix/cachix-action@v16
-        with:
-          name: devenv
-      - name: Install devenv.sh
-        run: nix profile install nixpkgs#devenv
       - name: Setup go
         uses: actions/setup-go@v4
         with:
@@ -37,12 +32,12 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GH_PAT_TOKEN }}
       - name: Bump version and push tag
         run: |
-          nix develop --no-pure-eval --accept-flake-config --command bash -c 'prepare-release'
+          nix develop --accept-flake-config --command bash -c 'prepare-release'
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v4
         with:
           distribution: goreleaser
           version: latest
           args: release --clean
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,7 +1,4 @@
-/gomod2nix-template
 .direnv
-.devenv 
 .pre-commit-config.yaml
 result/
-vendor/
-ess
+/ess

.ignore

@@ -0,0 +1,2 @@
+.direnv
+vendor

README.md

@@ -6,19 +6,19 @@ Automatically keep `env.sample` files in sync with `.env`
 
 ---
 
-`ess` transforms environment files containing secrets (e.g. `.env`, `.envrc`) into sample environment files (e.g. 
+`ess` transforms environment files containing secrets (e.g. `.env`, `.envrc`) into sample environment files (e.g.
 `env.sample`) that may be safely checked into git.
 
 `ess` may be run manually by running the cli executable, or automatically by installing the pre-commit hook with `ess install`
-in any git repository. Installing `ess` as a git hook ensures that project environment files are automatically and safely 
-revision controlled when they change. 
+in any git repository. Installing `ess` as a git hook ensures that project environment files are automatically and safely
+revision controlled when they change.
 
 Doing so allows environment configurations to be shared across teams without leaking secrets.
 
-## How it works 
+## How it works
 
 By default, `ess` checks the local directory for environment files named `.env`. The env file name is controlled by
-the `--env-file` switch. Next, the environment file is parsed for environment variables. Environment variables 
+the `--env-file` switch. Next, the environment file is parsed for environment variables. Environment variables
 may be of the following forms:
 
 ```
@@ -35,16 +35,16 @@ export FOO='bar baz'
 
 By default, variable values are replaced with innert values named after the variable, e.g. `FOO=bar` is replaced by `FOO=<FOO>`.
 
-Example values may be provided with the `--example` switch, e.g. `--exmaple=FOO="enter your foo here"` will set `FOO`'s 
-value as follows `FOO="enter your foo here"` in the sample file. 
+Example values may be provided with the `--example` switch, e.g. `--exmaple=FOO="enter your foo here"` will set `FOO`'s
+value as follows `FOO="enter your foo here"` in the sample file.
 
-Finally, when all variables are replaced, the sample file is written with the sanitized variable values, along with all 
+Finally, when all variables are replaced, the sample file is written with the sanitized variable values, along with all
 non-variable strings from the file. By default the sample file is named `env.sample`, which is controlled by the `--env-sample`
-switch. 
+switch.
 
-Because `ess` permits non-variable strings in environment files, it means that both comments and script code (in the case 
-of `.envrc` files) is included in environment sample files. This allows environment files to not only be checked into git, but 
-documented with comments. 
+Because `ess` permits non-variable strings in environment files, it means that both comments and script code (in the case
+of `.envrc` files) is included in environment sample files. This allows environment files to not only be checked into git, but
+documented with comments.
 
 # Installation & Usage
 
@@ -153,10 +153,10 @@ This utility can be used as a [pre-commit plugin](https://pre-commit.com/#instal
 
 ## Add configuration
 ```bash
-cat <<EOF > .pre-commit-config.yaml
+cat <<EOF >.pre-commit-config.yaml
 repos:
 -   repo: https://github.com/acaloiaro/ess.git
-    rev: v2.14.1
+    rev: v2.17.0
     hooks:
       - id: ess
 EOF
@@ -214,7 +214,7 @@ It's even possible to provide default/example values for every environment varia
 ```yml
 repos:
 -   repo: https://github.com/acaloiaro/ess.git
-    rev: v2.14.1
+    rev: v2.17.0
     hooks:
       - id: ess
 ```
@@ -224,7 +224,7 @@ repos:
 ```yml
 repos:
 -   repo: https://github.com/acaloiaro/ess.git
-    rev: v2.14.1
+    rev: v2.17.0
     hooks:
       - id: ess
         args: ['--env-file=.env_file', '--sample-file=env_file.sample']
@@ -239,7 +239,7 @@ environment variable name surrounded by `<brackets like this>` in sample files.
 ```yml
 repos:
 -   repo: https://github.com/acaloiaro/ess.git
-    rev: v2.14.1
+    rev: v2.17.0
     hooks:
       - id: ess
         args: [--example=FOO="Provide your foo here", --example=BAR="You can fetch bars from https://example.com/bars"]
@@ -258,4 +258,3 @@ Example sample file output
 FOO=Provide your foo here
 BAR=You can fetch bars from https://example.com/bars
 ```
-

default.nix

@@ -1,21 +1,22 @@
 {
-  pkgs ? (
-    let
-      inherit (builtins) fetchTree fromJSON readFile;
-      inherit ((fromJSON (readFile ./flake.lock)).nodes) nixpkgs;
-    in
-      import (fetchTree nixpkgs.locked) {}
-  ),
-  buildGoModule ? pkgs.buildGoModule,
+  self,
+  pkgs ? import <nixpkgs> {},
+  ...
 }:
-buildGoModule {
+pkgs.buildGoModule rec {
+  env.CGO_ENABLED = 0;
   pname = "ess";
-  version = "2.16.4";
-  pwd = ./.;
+  version = pkgs.lib.strings.removeSuffix "\n" (builtins.readFile ./version.txt);
   src = ./.;
-  vendorHash = "sha256-ooTP3mS7AEzwJm1JKebL0V2lqVge3WnpFZcbr1f/LIg=";
+  vendorHash = null;
+  ldflags = [
+    "-X 'main.version=${version}-nix'"
+    "-X 'main.commit=${self.rev or "dev"}'"
+  ];
+
   meta = {
     description = "ess (env-sample-sync): automatically and safely synchronize env.sample files with .env";
+    homepage = "https://github.com/acaloiaro/ess";
     license = pkgs.lib.licenses.bsd2;
   };
 }