Merge pull request #191 from nix-community/version-flag

add version flag

Author: brianmcgee

cmd/root.go

@@ -11,12 +11,14 @@ import (
 
 	"github.com/numtide/nixos-facter/pkg/facter"
 	"github.com/numtide/nixos-facter/pkg/hwinfo"
+	"github.com/numtide/nixos-facter/pkg/build"
 )
 
 var (
 	outputPath       string
 	logLevel         string
 	hardwareFeatures []string
+	version					bool
 
 	scanner = facter.Scanner{}
 )
@@ -30,6 +32,10 @@ func init() {
 		&scanner.Ephemeral, "ephemeral", false,
 		"capture all ephemeral properties e.g. swap, filesystems and so on",
 	)
+	flag.BoolVar(
+		&version, "version", false,
+		"print version and exit",
+	)
 	flag.StringVar(&logLevel, "log-level", "info", "log level")
 
 	defaultFeatures := []string{
@@ -56,7 +62,7 @@ func init() {
 	defaultValues := strings.Join(defaultFeatures, ",")
 
 	const usage = `nixos-facter [flags]
-Hardware report generator
+Hardware report generator %s (%s)
 
 Usage:
   nixos-facter [flags]
@@ -66,6 +72,7 @@ Flags:
   -h, --help           help for nixos-facter
   -o, --output string  path to write the report
   --swap               capture swap entries
+  --version            version for nixos-facter
   --log-level string   log level, one of <error|warn|info|debug> (default "info")
   --hardware strings   Hardware items to probe.
                        Default: %s
@@ -74,12 +81,17 @@ Flags:
 `
 
 	// Custom usage function
-	flag.Usage = func() { fmt.Fprintf(os.Stderr, usage, defaultValues, possibleValues) }
+	flag.Usage = func() { fmt.Fprintf(os.Stderr, usage, build.Version, build.System, defaultValues, possibleValues) }
 }
 
 func Execute() {
 	flag.Parse()
 
+	if version {
+		fmt.Printf("%s\n", build.Version)
+		return
+	}
+
 	// Check if the effective user id is 0 e.g. root
 	if os.Geteuid() != 0 {
 		log.Fatalf("you must run this program as root")

nix/packages/nixos-facter/default.nix

@@ -19,7 +19,7 @@ in
     # there's no good way of tying in the version to a git tag or branch
     # so for simplicity's sake we set the version as the commit revision hash
     # we remove the `-dirty` suffix to avoid a lot of unnecessary rebuilds in local dev
-    version = lib.removeSuffix "-dirty" (flake.shortRev or flake.dirtyShortRev);
+    versionSuffix = "-${lib.removeSuffix "-dirty" (flake.shortRev or flake.dirtyShortRev)}";
   }
   // {
     passthru.tests = import ./tests args;

nix/packages/nixos-facter/package.nix

@@ -1,19 +1,20 @@
 {
   lib,
-  version ? "0.3.1",
+  versionSuffix ? null,
   systemdMinimal,
   hwinfo,
   gcc,
   makeWrapper,
   pkg-config,
   stdenv,
   buildGo124Module,
+  versionCheckHook,
 }: let
   fs = lib.fileset;
 in
   buildGo124Module (final: {
     pname = "nixos-facter";
-    inherit version;
+    version  = "0.3.2";
 
     src = fs.toSource {
       root = ../../..;
@@ -29,24 +30,26 @@ in
     vendorHash = "sha256-A7ZuY8Gc/a0Y8O6UG2WHWxptHstJOxi4n9F8TY6zqiw=";
 
     buildInputs = [
-      systemdMinimal.dev
+      systemdMinimal
       hwinfo
     ];
 
     nativeBuildInputs = [
       gcc
       makeWrapper
       pkg-config
+      versionCheckHook
     ];
 
     ldflags = [
       "-s"
       "-w"
       "-X github.com/numtide/nixos-facter/pkg/build.Name=${final.pname}"
-      "-X github.com/numtide/nixos-facter/pkg/build.Version=v${final.version}"
+      "-X github.com/numtide/nixos-facter/pkg/build.Version=v${final.version}${toString versionSuffix}"
       "-X github.com/numtide/nixos-facter/pkg/build.System=${stdenv.hostPlatform.system}"
     ];
 
+    doInstallCheck = true;
     postInstall = let
       binPath = lib.makeBinPath [
         systemdMinimal

nix/packages/nixos-facter/tests/default.nix

@@ -24,6 +24,8 @@ in
       installPhase = ''
         touch $out
       '';
+      doInstallCheck = false;
+      doCheck = false;
     });
 
     basic = diskoLib.testLib.makeDiskoTest {

scripts/create-release.sh

@@ -28,6 +28,9 @@ if [[ $unpushed_commits != "" ]]; then
   echo -e "\nThere are unpushed changes, exiting:\n$unpushed_commits" >&2
   exit 1
 fi
+sed -i "s/version = \".*\"/version = \"$version\"/" ./nix/packages/nixos-facter/default.nix
+git add ./nix/packages/nixos-facter/default.nix
+git commit -m "release: v${version}"
 nix flake check -vL
 git tag "v${version}"