From d3ece5991953e16e287c5c988496bd6dd8cf861c Mon Sep 17 00:00:00 2001
From: Erik Arvstedt <erik.arvstedt@gmail.com>
Date: Mon, 12 Oct 2020 13:33:48 +0200
Subject: [PATCH] add module 'versioning'

---
 examples/configuration.nix |  5 ++++
 modules/modules.nix        |  1 +
 modules/versioning.nix     | 59 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 65 insertions(+)
 create mode 100644 modules/versioning.nix

diff --git a/examples/configuration.nix b/examples/configuration.nix
index 25abdb2..f4ef69a 100644
--- a/examples/configuration.nix
+++ b/examples/configuration.nix
@@ -209,4 +209,9 @@
   # servers. You should change this only after NixOS release notes say you
   # should.
   system.stateVersion = "18.09"; # Did you read the comment?
+
+  # The nix-bitcoin release version that your config is compatible with.
+  # When upgrading to a backwards-incompatible release, nix-bitcoin will display an
+  # an error and provide hints for migrating your config to the new release.
+  nix-bitcoin.configVersion = "0.0.18";
 }
diff --git a/modules/modules.nix b/modules/modules.nix
index 64619b2..13801ae 100644
--- a/modules/modules.nix
+++ b/modules/modules.nix
@@ -22,6 +22,7 @@
     ./recurring-donations.nix
 
     # Support features
+    ./versioning.nix
     ./security.nix
     ./netns-isolation.nix
     ./backups.nix
diff --git a/modules/versioning.nix b/modules/versioning.nix
new file mode 100644
index 0000000..4635254
--- /dev/null
+++ b/modules/versioning.nix
@@ -0,0 +1,59 @@
+{ config, pkgs, lib, ... }:
+
+with lib;
+let
+  version = config.nix-bitcoin.configVersion;
+
+  # Sorted by increasing version numbers
+  changes = [
+    # None yet
+    # {
+    #   version = "0.1";
+    #   condition = config.services.foo.enabled;
+    #   message = ''
+    #     demo message
+    #   '';
+    # }
+  ];
+
+  incompatibleChanges = optionals
+    (version != null && versionOlder lastChange)
+    (builtins.filter (change: versionOlder change && (change.condition or true)) changes);
+
+  errorMsg = ''
+
+    This version of nix-bitcoin contains the following changes
+    that are incompatible with your config (version ${version}):
+
+    ${concatMapStringsSep "\n" (change: ''
+      - ${change.message}(This change was introduced in version ${change.version})
+    '') incompatibleChanges}
+    After addressing the above changes, set nix-bitcoin.configVersion = "${lastChange.version}";
+    in your nix-bitcoin configuration.
+  '';
+
+  versionOlder = change: (builtins.compareVersions change.version version) > 0;
+  lastChange = builtins.elemAt changes (builtins.length changes - 1);
+in
+{
+  options = {
+    nix-bitcoin.configVersion = mkOption {
+      type = with types; nullOr str;
+      default = null;
+      description = ''
+        Set this option to the nix-bitcoin release version that your config is
+        compatible with.
+
+        When upgrading to a backwards-incompatible release, nix-bitcoin will throw an
+        error during evaluation and provide hints for migrating your config to the
+        new release.
+      '';
+    };
+  };
+
+  ## No config because there are no backwards incompatible releases yet
+  # config = {
+  #   # Force evaluation. An actual option value is never assigned
+  #   system.extraDependencies = optional (builtins.length incompatibleChanges > 0) (builtins.throw errorMsg);
+  # };
+}