add comment on hercules config

Liqwid-Labs · Mar 22, 2023 · 94b6c12 · 94b6c12
1 parent 22552f6
commit 94b6c12
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/nix/ci-config.nix b/nix/ci-config.nix
@@ -67,7 +67,11 @@ in
       );
   };
   config = {
+    # NOTE(Emily, 22 Mar 2023): Here we provide sensible defaults for working with liqwid-nix. 
+    # These can be overwritten by the user, though. In the future, we may want some out-of-the-
+    # -box implementation for enabling this somehow.
     flake = { ... }: {
+      # Added in: 2.7.2.
       config.herculesCI = {
         ciSystems = [ "x86_64-linux" ];
         onPush.default.outputs = self.checks.x86_64-linux;