From 69feb3521b053a47402998fc53465876bd767ac4 Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Sat, 2 Dec 2023 22:13:50 +0100
Subject: [PATCH 01/12] Add populate-cache-effect

---
 effects/populate-cache/default.nix | 179 +++++++++++++++++++++++++++++
 flake.lock                         | 129 +++++++++++++++++++++
 flake.nix                          |   6 +
 3 files changed, 314 insertions(+)
 create mode 100644 effects/populate-cache/default.nix

diff --git a/effects/populate-cache/default.nix b/effects/populate-cache/default.nix
new file mode 100644
index 0000000..42dba17
--- /dev/null
+++ b/effects/populate-cache/default.nix
@@ -0,0 +1,179 @@
+{inputs, withSystem, ...}:
+let
+  attic-client = inputs.attic.packages."x86_64-linux".attic-client;
+  cachix = withSystem "x86_64-linux" ({pkgs, ...}: pkgs.cachix);
+  in
+{
+  inputs,
+  lib,
+  withSystem,
+  config,
+  ...
+}: {
+  imports = [
+    inputs.hercules-ci-effects.flakeModule
+  ];
+
+  options = {
+    populate-cache-effect = {
+      enable = lib.mkOption {
+        type = lib.types.bool;
+        default = false;
+        description = "Enables HerculesCI effects populating some external cache.";
+      };
+      attic-client-pkg = lib.mkOption {
+        type = lib.types.package;
+        description = "Version of the attic-client package to use on \"x86_64-linux\".";
+        default = attic-client;
+      };
+      cachix-pkg = lib.mkOption {
+        type = lib.types.package;
+        description = "Version of the cachix package to use on \"x86_64-linux\".";
+        default = cachix;
+      };
+      caches = lib.mkOption {
+        description = "
+          An attribute set, each `name: value` pair translates to an effect under
+          onPush.default.outputs.effects.populate-cache-effect.name
+        ";
+        example = "
+          {
+            our-cachix = {
+              type = \"cachix\";
+              secretName = \"our-cachix-token\";
+              branches = [ \"master\" ];
+              packages = [ pkgs.hello ];
+            };
+          }
+        ";
+        type = lib.types.attrsOf (lib.types.submodule (
+          {name, ...}: {
+            options = {
+              name = lib.mkOption {
+                type = lib.types.str;
+                default = name;
+                description = ''
+                  Name of the effect. By default it's the attribute name.
+                '';
+              };
+              type = lib.mkOption {
+                type = lib.types.enum ["attic" "cachix"];
+                description = "A string \"attic\" or \"cachix\".";
+              };
+              packages = lib.mkOption {
+                type = with lib.types; listOf package;
+                description = "List of packages to push to the cache.";
+                example = "[ pkgs.hello ]";
+              };
+              secretName = lib.mkOption {
+                type = lib.types.str;
+                description = ''
+                  Name of the HerculesCI secret. See [HerculesCI docs](https://docs.hercules-ci.com/hercules-ci-agent/secrets-json).
+                  The secrets "data" field should contain given data:
+
+                  ```
+                    "data": {
+                      "name": "my-cache-name",
+                      "token": "ey536428341723812",
+                      "endpoint": "https://my-cache-name.com"
+                    }
+                  ```
+
+                  The "endpoint" field is needed for Attic cache. With Cachix cache the "endpoint" field is not read and can be absent.
+                '';
+              };
+              branches = lib.mkOption {
+                type = with lib.types; listOf str;
+                description = ''
+                  Branches on which we'd like to execute the effect.
+                '';
+              };
+            };
+          }
+        ));
+      };
+    };
+  };
+
+  config = let
+    # file with all the package paths written line by line
+    # nixpkgs -> [derivation] -> derivation
+    packagesFile = pkgs: packages:
+      pkgs.writeText "pushed-paths"
+      (lib.strings.concatStringsSep "\n" (builtins.map builtins.toString packages));
+
+    mkAtticPushEffect = {
+      cacheOptions,
+      branch,
+    }:
+      withSystem "x86_64-linux" (
+        {
+          hci-effects,
+          pkgs,
+          ...
+        }: let
+          pushEffect = hci-effects.mkEffect {
+            inputs = [attic-client-pkg];
+            secretsMap = {
+              token-file = "${cacheOptions.secretName}";
+            };
+            userSetupScript = ''
+              attic login \
+                server-name \
+                $(readSecretString token-file .endpoint) \
+                $(readSecretString token-file .token)
+            '';
+            effectScript = ''
+              cat ${packagesFile pkgs cacheOptions.packages} | xargs -s 4096 attic push server-name:$(readSecretString token-file .name)
+            '';
+          };
+        in
+          hci-effects.runIf (builtins.elem branch cacheOptions.branches) pushEffect
+      );
+
+    mkCachixPushEffect = {
+      cacheOptions,
+      branch,
+    }:
+      withSystem "x86_64-linux" (
+        {
+          hci-effects,
+          pkgs,
+          ...
+        }: let
+          pushEffect = hci-effects.mkEffect {
+            inputs = [cachix];
+            secretsMap = {
+              token-file = "${cacheOptions.secretName}";
+            };
+            userSetupScript = ''
+              cachix authtoken $(readSecretString token-file .token)
+            '';
+            effectScript = ''
+              cat ${packagesFile pkgs cacheOptions.packages} | cachix push $(readSecretString token-file .name)
+            '';
+          };
+        in
+          hci-effects.runIf (builtins.elem branch cacheOptions.branches) pushEffect
+      );
+  in
+    lib.mkIf config.populate-cache-effect.enable {
+      herculesCI = herculesConfig: {
+        onPush.default.outputs.effects.populate-cache-effect =
+          lib.attrsets.mapAttrs' (_: cacheOptions: {
+            inherit (cacheOptions) name;
+            value = builtins.getAttr "${cacheOptions.type}" {
+              attic = mkAtticPushEffect {
+                inherit cacheOptions;
+                inherit (herculesConfig.config.repo) branch;
+              };
+              cachix = mkCachixPushEffect {
+                inherit cacheOptions;
+                inherit (herculesConfig.config.repo) branch;
+              };
+            };
+          })
+          config.populate-cache-effect.caches;
+      };
+    };
+}
diff --git a/flake.lock b/flake.lock
index 104bc5e..202df6d 100644
--- a/flake.lock
+++ b/flake.lock
@@ -1,5 +1,75 @@
 {
   "nodes": {
+    "attic": {
+      "inputs": {
+        "crane": "crane",
+        "flake-compat": "flake-compat",
+        "flake-utils": "flake-utils",
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable"
+      },
+      "locked": {
+        "lastModified": 1698258239,
+        "narHash": "sha256-qnhoYYIJ0L/P7H/f56lQUEvpzNlXh4sxuHpRERV+B44=",
+        "owner": "zhaofengli",
+        "repo": "attic",
+        "rev": "e9918bc6be268da6fa97af6ced15193d8a0421c0",
+        "type": "github"
+      },
+      "original": {
+        "owner": "zhaofengli",
+        "repo": "attic",
+        "type": "github"
+      }
+    },
+    "crane": {
+      "inputs": {
+        "flake-compat": [
+          "attic",
+          "flake-compat"
+        ],
+        "flake-utils": [
+          "attic",
+          "flake-utils"
+        ],
+        "nixpkgs": [
+          "attic",
+          "nixpkgs"
+        ],
+        "rust-overlay": "rust-overlay"
+      },
+      "locked": {
+        "lastModified": 1677892403,
+        "narHash": "sha256-/Wi0L1spSWLFj+UQxN3j0mPYMoc7ZoAujpUF/juFVII=",
+        "owner": "ipetkov",
+        "repo": "crane",
+        "rev": "105e27adb70a9890986b6d543a67761cbc1964a2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "ipetkov",
+        "repo": "crane",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
     "flake-parts": {
       "inputs": {
         "nixpkgs-lib": [
@@ -19,6 +89,21 @@
         "type": "indirect"
       }
     },
+    "flake-utils": {
+      "locked": {
+        "lastModified": 1667395993,
+        "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
         "lastModified": 1709961763,
@@ -35,11 +120,55 @@
         "type": "github"
       }
     },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1685004253,
+        "narHash": "sha256-AbVL1nN/TDicUQ5wXZ8xdLERxz/eJr7+o8lqkIOVuaE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "3e01645c40b92d29f3ae76344a6d654986a91a91",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
+        "attic": "attic",
         "flake-parts": "flake-parts",
         "nixpkgs": "nixpkgs"
       }
+    },
+    "rust-overlay": {
+      "inputs": {
+        "flake-utils": [
+          "attic",
+          "crane",
+          "flake-utils"
+        ],
+        "nixpkgs": [
+          "attic",
+          "crane",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1675391458,
+        "narHash": "sha256-ukDKZw922BnK5ohL9LhwtaDAdCsJL7L6ScNEyF1lO9w=",
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "rev": "383a4acfd11d778d5c2efcf28376cbd845eeaedf",
+        "type": "github"
+      },
+      "original": {
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "type": "github"
+      }
     }
   },
   "root": "root",
diff --git a/flake.nix b/flake.nix
index 1d314f9..46d4513 100644
--- a/flake.nix
+++ b/flake.nix
@@ -3,6 +3,12 @@
 
   inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
   inputs.flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
+  inputs.attic = {
+    url = "github:zhaofengli/attic";
+    inputs = {
+      nixpkgs.follows = "nixpkgs";
+    };
+  };
 
   outputs = inputs@{ self, nixpkgs, flake-parts, ... }:
     flake-parts.lib.mkFlake { inherit inputs; }

From 88b2d2e8c8f277f2752409781cef47bd876ae79c Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Thu, 7 Dec 2023 19:27:22 +0100
Subject: [PATCH 02/12] Remove attic flake input & Rename to push & small fixes

---
 effects/populate-cache/default.nix |  37 +++++----
 flake.lock                         | 129 -----------------------------
 flake.nix                          |   6 --
 3 files changed, 22 insertions(+), 150 deletions(-)

diff --git a/effects/populate-cache/default.nix b/effects/populate-cache/default.nix
index 42dba17..b5f23e5 100644
--- a/effects/populate-cache/default.nix
+++ b/effects/populate-cache/default.nix
@@ -1,40 +1,47 @@
-{inputs, withSystem, ...}:
-let
-  attic-client = inputs.attic.packages."x86_64-linux".attic-client;
-  cachix = withSystem "x86_64-linux" ({pkgs, ...}: pkgs.cachix);
-  in
 {
   inputs,
   lib,
   withSystem,
   config,
   ...
-}: {
+}: let
+  pkgs-x86_64-linux = withSystem "x86_64-linux" ({pkgs, ...}: pkgs);
+  in
+  {
   imports = [
     inputs.hercules-ci-effects.flakeModule
   ];
 
   options = {
-    populate-cache-effect = {
+    push-cache-effect = {
       enable = lib.mkOption {
         type = lib.types.bool;
         default = false;
-        description = "Enables HerculesCI effects populating some external cache.";
+        description = ''
+          Enables an effect that pushes certain outputs to a different binary cache.
+
+          Hercules CI normally pushes everything to the cache(s) configured on the agent. This effect supplements that behavior by letting you push a subset of those to a different cache.
+          Note that it only pushes the output closure, and not the closures of build dependencies used during the build stage of the CI job. (Unless those closures happen to also be part of the output or "runtime" closure)
+        '';
       };
       attic-client-pkg = lib.mkOption {
         type = lib.types.package;
-        description = "Version of the attic-client package to use on \"x86_64-linux\".";
-        default = attic-client;
+        description = ''
+          Version of the attic-client package to use on \"x86_64-linux\".
+          
+          Hint: You can use `attic.packages.x86_64-linux.attic-client` from the attic flake.
+        '';
+        default = pkgs-x86_64-linux.attic-client or (throw "push-cache-effect.attic-client-pkg: It seems that attic hasn't been packaged in Nixpkgs (yet?). Please check <nixpkgs packaging request issue> or set <option> manually.");
       };
       cachix-pkg = lib.mkOption {
         type = lib.types.package;
+        default = pkgs-x86_64-linux.cachix;
         description = "Version of the cachix package to use on \"x86_64-linux\".";
-        default = cachix;
       };
       caches = lib.mkOption {
         description = "
           An attribute set, each `name: value` pair translates to an effect under
-          onPush.default.outputs.effects.populate-cache-effect.name
+          onPush.default.outputs.effects.push-cache-effect.name
         ";
         example = "
           {
@@ -157,9 +164,9 @@ let
           hci-effects.runIf (builtins.elem branch cacheOptions.branches) pushEffect
       );
   in
-    lib.mkIf config.populate-cache-effect.enable {
+    lib.mkIf config.push-cache-effect.enable {
       herculesCI = herculesConfig: {
-        onPush.default.outputs.effects.populate-cache-effect =
+        onPush.default.outputs.effects.push-cache-effect =
           lib.attrsets.mapAttrs' (_: cacheOptions: {
             inherit (cacheOptions) name;
             value = builtins.getAttr "${cacheOptions.type}" {
@@ -173,7 +180,7 @@ let
               };
             };
           })
-          config.populate-cache-effect.caches;
+          config.push-cache-effect.caches;
       };
     };
 }
diff --git a/flake.lock b/flake.lock
index 202df6d..104bc5e 100644
--- a/flake.lock
+++ b/flake.lock
@@ -1,75 +1,5 @@
 {
   "nodes": {
-    "attic": {
-      "inputs": {
-        "crane": "crane",
-        "flake-compat": "flake-compat",
-        "flake-utils": "flake-utils",
-        "nixpkgs": [
-          "nixpkgs"
-        ],
-        "nixpkgs-stable": "nixpkgs-stable"
-      },
-      "locked": {
-        "lastModified": 1698258239,
-        "narHash": "sha256-qnhoYYIJ0L/P7H/f56lQUEvpzNlXh4sxuHpRERV+B44=",
-        "owner": "zhaofengli",
-        "repo": "attic",
-        "rev": "e9918bc6be268da6fa97af6ced15193d8a0421c0",
-        "type": "github"
-      },
-      "original": {
-        "owner": "zhaofengli",
-        "repo": "attic",
-        "type": "github"
-      }
-    },
-    "crane": {
-      "inputs": {
-        "flake-compat": [
-          "attic",
-          "flake-compat"
-        ],
-        "flake-utils": [
-          "attic",
-          "flake-utils"
-        ],
-        "nixpkgs": [
-          "attic",
-          "nixpkgs"
-        ],
-        "rust-overlay": "rust-overlay"
-      },
-      "locked": {
-        "lastModified": 1677892403,
-        "narHash": "sha256-/Wi0L1spSWLFj+UQxN3j0mPYMoc7ZoAujpUF/juFVII=",
-        "owner": "ipetkov",
-        "repo": "crane",
-        "rev": "105e27adb70a9890986b6d543a67761cbc1964a2",
-        "type": "github"
-      },
-      "original": {
-        "owner": "ipetkov",
-        "repo": "crane",
-        "type": "github"
-      }
-    },
-    "flake-compat": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1673956053,
-        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
-        "owner": "edolstra",
-        "repo": "flake-compat",
-        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
-        "type": "github"
-      },
-      "original": {
-        "owner": "edolstra",
-        "repo": "flake-compat",
-        "type": "github"
-      }
-    },
     "flake-parts": {
       "inputs": {
         "nixpkgs-lib": [
@@ -89,21 +19,6 @@
         "type": "indirect"
       }
     },
-    "flake-utils": {
-      "locked": {
-        "lastModified": 1667395993,
-        "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    },
     "nixpkgs": {
       "locked": {
         "lastModified": 1709961763,
@@ -120,55 +35,11 @@
         "type": "github"
       }
     },
-    "nixpkgs-stable": {
-      "locked": {
-        "lastModified": 1685004253,
-        "narHash": "sha256-AbVL1nN/TDicUQ5wXZ8xdLERxz/eJr7+o8lqkIOVuaE=",
-        "owner": "NixOS",
-        "repo": "nixpkgs",
-        "rev": "3e01645c40b92d29f3ae76344a6d654986a91a91",
-        "type": "github"
-      },
-      "original": {
-        "owner": "NixOS",
-        "ref": "nixos-23.05",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
     "root": {
       "inputs": {
-        "attic": "attic",
         "flake-parts": "flake-parts",
         "nixpkgs": "nixpkgs"
       }
-    },
-    "rust-overlay": {
-      "inputs": {
-        "flake-utils": [
-          "attic",
-          "crane",
-          "flake-utils"
-        ],
-        "nixpkgs": [
-          "attic",
-          "crane",
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1675391458,
-        "narHash": "sha256-ukDKZw922BnK5ohL9LhwtaDAdCsJL7L6ScNEyF1lO9w=",
-        "owner": "oxalica",
-        "repo": "rust-overlay",
-        "rev": "383a4acfd11d778d5c2efcf28376cbd845eeaedf",
-        "type": "github"
-      },
-      "original": {
-        "owner": "oxalica",
-        "repo": "rust-overlay",
-        "type": "github"
-      }
     }
   },
   "root": "root",
diff --git a/flake.nix b/flake.nix
index 46d4513..1d314f9 100644
--- a/flake.nix
+++ b/flake.nix
@@ -3,12 +3,6 @@
 
   inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
   inputs.flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
-  inputs.attic = {
-    url = "github:zhaofengli/attic";
-    inputs = {
-      nixpkgs.follows = "nixpkgs";
-    };
-  };
 
   outputs = inputs@{ self, nixpkgs, flake-parts, ... }:
     flake-parts.lib.mkFlake { inherit inputs; }

From 4ac73c0dff3c275bf8ef45a61d8a49c1c650aaba Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Thu, 7 Dec 2023 19:46:31 +0100
Subject: [PATCH 03/12] Fix branches option

---
 effects/populate-cache/default.nix | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/effects/populate-cache/default.nix b/effects/populate-cache/default.nix
index b5f23e5..9a54609 100644
--- a/effects/populate-cache/default.nix
+++ b/effects/populate-cache/default.nix
@@ -90,9 +90,10 @@
                 '';
               };
               branches = lib.mkOption {
-                type = with lib.types; listOf str;
+                type = with lib.types; nullOr (listOf str);
+                default = null;
                 description = ''
-                  Branches on which we'd like to execute the effect.
+                  Branches on which we'd like to execute the effect. Set to `nil` to execute on all branches.
                 '';
               };
             };
@@ -135,7 +136,7 @@
             '';
           };
         in
-          hci-effects.runIf (builtins.elem branch cacheOptions.branches) pushEffect
+          hci-effects.runIf ((cacheOptions.branches == null) || (builtins.elem branch cacheOptions.branches)) pushEffect
       );
 
     mkCachixPushEffect = {

From bb67abfa0d1560efa2243576eadb2ddbf48e3d5f Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:03:35 +0100
Subject: [PATCH 04/12] Rename

---
 effects/{populate-cache => push-cache}/default.nix | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
 rename effects/{populate-cache => push-cache}/default.nix (99%)

diff --git a/effects/populate-cache/default.nix b/effects/push-cache/default.nix
similarity index 99%
rename from effects/populate-cache/default.nix
rename to effects/push-cache/default.nix
index 9a54609..9ab1f2d 100644
--- a/effects/populate-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -1,5 +1,4 @@
 {
-  inputs,
   lib,
   withSystem,
   config,
@@ -9,7 +8,7 @@
   in
   {
   imports = [
-    inputs.hercules-ci-effects.flakeModule
+    .././flake-module.nix
   ];
 
   options = {

From 79681bdbdb8346c27abfe28e7a301cb3c79aa208 Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:10:04 +0100
Subject: [PATCH 05/12] Export push-cache effect

---
 effects/default.nix            | 2 ++
 effects/push-cache/default.nix | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/effects/default.nix b/effects/default.nix
index 5609466..36e1370 100644
--- a/effects/default.nix
+++ b/effects/default.nix
@@ -92,6 +92,8 @@ checkVersion
 
   effectVMTest = callPackage ./effect-vm-test { extraModule = { config.hci = pkgs.hci; }; };
 
+  push-cache = import ./push-cache;
+
   effects = self;
   hci-effects = self;
 
diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index 9ab1f2d..60f0b49 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -92,7 +92,7 @@
                 type = with lib.types; nullOr (listOf str);
                 default = null;
                 description = ''
-                  Branches on which we'd like to execute the effect. Set to `nil` to execute on all branches.
+                  Branches on which we'd like to execute the effect. Set to `null` to execute on all branches.
                 '';
               };
             };

From f3d04261862daa9787c46bd0bddbff5ae645c72e Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:23:45 +0100
Subject: [PATCH 06/12] Move export

---
 effects/default.nix      | 2 --
 flake-public-outputs.nix | 2 ++
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/effects/default.nix b/effects/default.nix
index 36e1370..5609466 100644
--- a/effects/default.nix
+++ b/effects/default.nix
@@ -92,8 +92,6 @@ checkVersion
 
   effectVMTest = callPackage ./effect-vm-test { extraModule = { config.hci = pkgs.hci; }; };
 
-  push-cache = import ./push-cache;
-
   effects = self;
   hci-effects = self;
 
diff --git a/flake-public-outputs.nix b/flake-public-outputs.nix
index a9e0189..ce64fae 100644
--- a/flake-public-outputs.nix
+++ b/flake-public-outputs.nix
@@ -8,6 +8,8 @@
 
     flakeModule = ./flake-module.nix;
 
+    push-cache-module = ./effects/push-cache;
+
     lib.withPkgs = pkgs:
       let effects = import ./effects/default.nix effects pkgs;
       in effects;

From b225c978b1846dcd00553bf5e0248a16f24fc408 Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:30:45 +0100
Subject: [PATCH 07/12] Format

---
 effects/push-cache/default.nix | 218 ++++++++++++++-------------------
 1 file changed, 91 insertions(+), 127 deletions(-)

diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index 60f0b49..46f38ff 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -1,15 +1,7 @@
-{
-  lib,
-  withSystem,
-  config,
-  ...
-}: let
-  pkgs-x86_64-linux = withSystem "x86_64-linux" ({pkgs, ...}: pkgs);
-  in
-  {
-  imports = [
-    .././flake-module.nix
-  ];
+{ lib, withSystem, config, ... }:
+let pkgs-x86_64-linux = withSystem "x86_64-linux" ({ pkgs, ... }: pkgs);
+in {
+  imports = [ .././flake-module.nix ];
 
   options = {
     push-cache-effect = {
@@ -27,77 +19,67 @@
         type = lib.types.package;
         description = ''
           Version of the attic-client package to use on \"x86_64-linux\".
-          
+
           Hint: You can use `attic.packages.x86_64-linux.attic-client` from the attic flake.
         '';
-        default = pkgs-x86_64-linux.attic-client or (throw "push-cache-effect.attic-client-pkg: It seems that attic hasn't been packaged in Nixpkgs (yet?). Please check <nixpkgs packaging request issue> or set <option> manually.");
+        default = pkgs-x86_64-linux.attic-client or (throw
+          "push-cache-effect.attic-client-pkg: It seems that attic hasn't been packaged in Nixpkgs (yet?). Please check <nixpkgs packaging request issue> or set <option> manually.");
       };
       cachix-pkg = lib.mkOption {
         type = lib.types.package;
         default = pkgs-x86_64-linux.cachix;
-        description = "Version of the cachix package to use on \"x86_64-linux\".";
+        description =
+          ''Version of the cachix package to use on "x86_64-linux".'';
       };
       caches = lib.mkOption {
-        description = "
-          An attribute set, each `name: value` pair translates to an effect under
-          onPush.default.outputs.effects.push-cache-effect.name
-        ";
-        example = "
-          {
-            our-cachix = {
-              type = \"cachix\";
-              secretName = \"our-cachix-token\";
-              branches = [ \"master\" ];
-              packages = [ pkgs.hello ];
+        description =
+          "\n          An attribute set, each `name: value` pair translates to an effect under\n          onPush.default.outputs.effects.push-cache-effect.name\n        ";
+        example =
+          "\n          {\n            our-cachix = {\n              type = \"cachix\";\n              secretName = \"our-cachix-token\";\n              branches = [ \"master\" ];\n              packages = [ pkgs.hello ];\n            };\n          }\n        ";
+        type = lib.types.attrsOf (lib.types.submodule ({ name, ... }: {
+          options = {
+            name = lib.mkOption {
+              type = lib.types.str;
+              default = name;
+              description = ''
+                Name of the effect. By default it's the attribute name.
+              '';
+            };
+            type = lib.mkOption {
+              type = lib.types.enum [ "attic" "cachix" ];
+              description = ''A string "attic" or "cachix".'';
+            };
+            packages = lib.mkOption {
+              type = with lib.types; listOf package;
+              description = "List of packages to push to the cache.";
+              example = "[ pkgs.hello ]";
             };
-          }
-        ";
-        type = lib.types.attrsOf (lib.types.submodule (
-          {name, ...}: {
-            options = {
-              name = lib.mkOption {
-                type = lib.types.str;
-                default = name;
-                description = ''
-                  Name of the effect. By default it's the attribute name.
-                '';
-              };
-              type = lib.mkOption {
-                type = lib.types.enum ["attic" "cachix"];
-                description = "A string \"attic\" or \"cachix\".";
-              };
-              packages = lib.mkOption {
-                type = with lib.types; listOf package;
-                description = "List of packages to push to the cache.";
-                example = "[ pkgs.hello ]";
-              };
-              secretName = lib.mkOption {
-                type = lib.types.str;
-                description = ''
-                  Name of the HerculesCI secret. See [HerculesCI docs](https://docs.hercules-ci.com/hercules-ci-agent/secrets-json).
-                  The secrets "data" field should contain given data:
+            secretName = lib.mkOption {
+              type = lib.types.str;
+              description = ''
+                Name of the HerculesCI secret. See [HerculesCI docs](https://docs.hercules-ci.com/hercules-ci-agent/secrets-json).
+                The secrets "data" field should contain given data:
 
-                  ```
-                    "data": {
-                      "name": "my-cache-name",
-                      "token": "ey536428341723812",
-                      "endpoint": "https://my-cache-name.com"
-                    }
-                  ```
+                ```
+                  "data": {
+                    "name": "my-cache-name",
+                    "token": "ey536428341723812",
+                    "endpoint": "https://my-cache-name.com"
+                  }
+                ```
 
-                  The "endpoint" field is needed for Attic cache. With Cachix cache the "endpoint" field is not read and can be absent.
-                '';
-              };
-              branches = lib.mkOption {
-                type = with lib.types; nullOr (listOf str);
-                default = null;
-                description = ''
-                  Branches on which we'd like to execute the effect. Set to `null` to execute on all branches.
-                '';
-              };
+                The "endpoint" field is needed for Attic cache. With Cachix cache the "endpoint" field is not read and can be absent.
+              '';
             };
-          }
-        ));
+            branches = lib.mkOption {
+              type = with lib.types; nullOr (listOf str);
+              default = null;
+              description = ''
+                Branches on which we'd like to execute the effect. Set to `null` to execute on all branches.
+              '';
+            };
+          };
+        }));
       };
     };
   };
@@ -106,24 +88,15 @@
     # file with all the package paths written line by line
     # nixpkgs -> [derivation] -> derivation
     packagesFile = pkgs: packages:
-      pkgs.writeText "pushed-paths"
-      (lib.strings.concatStringsSep "\n" (builtins.map builtins.toString packages));
+      pkgs.writeText "pushed-paths" (lib.strings.concatStringsSep "\n"
+        (builtins.map builtins.toString packages));
 
-    mkAtticPushEffect = {
-      cacheOptions,
-      branch,
-    }:
-      withSystem "x86_64-linux" (
-        {
-          hci-effects,
-          pkgs,
-          ...
-        }: let
+    mkAtticPushEffect = { cacheOptions, branch, }:
+      withSystem "x86_64-linux" ({ hci-effects, pkgs, ... }:
+        let
           pushEffect = hci-effects.mkEffect {
-            inputs = [attic-client-pkg];
-            secretsMap = {
-              token-file = "${cacheOptions.secretName}";
-            };
+            inputs = [ attic-client-pkg ];
+            secretsMap = { token-file = "${cacheOptions.secretName}"; };
             userSetupScript = ''
               attic login \
                 server-name \
@@ -131,56 +104,47 @@
                 $(readSecretString token-file .token)
             '';
             effectScript = ''
-              cat ${packagesFile pkgs cacheOptions.packages} | xargs -s 4096 attic push server-name:$(readSecretString token-file .name)
+              cat ${
+                packagesFile pkgs cacheOptions.packages
+              } | xargs -s 4096 attic push server-name:$(readSecretString token-file .name)
             '';
           };
-        in
-          hci-effects.runIf ((cacheOptions.branches == null) || (builtins.elem branch cacheOptions.branches)) pushEffect
-      );
+        in hci-effects.runIf ((cacheOptions.branches == null)
+          || (builtins.elem branch cacheOptions.branches)) pushEffect);
 
-    mkCachixPushEffect = {
-      cacheOptions,
-      branch,
-    }:
-      withSystem "x86_64-linux" (
-        {
-          hci-effects,
-          pkgs,
-          ...
-        }: let
+    mkCachixPushEffect = { cacheOptions, branch, }:
+      withSystem "x86_64-linux" ({ hci-effects, pkgs, ... }:
+        let
           pushEffect = hci-effects.mkEffect {
-            inputs = [cachix];
-            secretsMap = {
-              token-file = "${cacheOptions.secretName}";
-            };
+            inputs = [ cachix ];
+            secretsMap = { token-file = "${cacheOptions.secretName}"; };
             userSetupScript = ''
               cachix authtoken $(readSecretString token-file .token)
             '';
             effectScript = ''
-              cat ${packagesFile pkgs cacheOptions.packages} | cachix push $(readSecretString token-file .name)
+              cat ${
+                packagesFile pkgs cacheOptions.packages
+              } | cachix push $(readSecretString token-file .name)
             '';
           };
-        in
-          hci-effects.runIf (builtins.elem branch cacheOptions.branches) pushEffect
-      );
-  in
-    lib.mkIf config.push-cache-effect.enable {
-      herculesCI = herculesConfig: {
-        onPush.default.outputs.effects.push-cache-effect =
-          lib.attrsets.mapAttrs' (_: cacheOptions: {
-            inherit (cacheOptions) name;
-            value = builtins.getAttr "${cacheOptions.type}" {
-              attic = mkAtticPushEffect {
-                inherit cacheOptions;
-                inherit (herculesConfig.config.repo) branch;
-              };
-              cachix = mkCachixPushEffect {
-                inherit cacheOptions;
-                inherit (herculesConfig.config.repo) branch;
-              };
+        in hci-effects.runIf (builtins.elem branch cacheOptions.branches)
+        pushEffect);
+  in lib.mkIf config.push-cache-effect.enable {
+    herculesCI = herculesConfig: {
+      onPush.default.outputs.effects.push-cache-effect = lib.attrsets.mapAttrs'
+        (_: cacheOptions: {
+          inherit (cacheOptions) name;
+          value = builtins.getAttr "${cacheOptions.type}" {
+            attic = mkAtticPushEffect {
+              inherit cacheOptions;
+              inherit (herculesConfig.config.repo) branch;
             };
-          })
-          config.push-cache-effect.caches;
-      };
+            cachix = mkCachixPushEffect {
+              inherit cacheOptions;
+              inherit (herculesConfig.config.repo) branch;
+            };
+          };
+        }) config.push-cache-effect.caches;
     };
+  };
 }

From ee2cdc18b6cff96c72c3178265d640d05b763cce Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:33:29 +0100
Subject: [PATCH 08/12] Fix

---
 effects/push-cache/default.nix | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index 46f38ff..6cf5cbd 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -95,7 +95,7 @@ in {
       withSystem "x86_64-linux" ({ hci-effects, pkgs, ... }:
         let
           pushEffect = hci-effects.mkEffect {
-            inputs = [ attic-client-pkg ];
+            inputs = [ config.push-cache-effect.attic-client-pkg ];
             secretsMap = { token-file = "${cacheOptions.secretName}"; };
             userSetupScript = ''
               attic login \
@@ -116,7 +116,7 @@ in {
       withSystem "x86_64-linux" ({ hci-effects, pkgs, ... }:
         let
           pushEffect = hci-effects.mkEffect {
-            inputs = [ cachix ];
+            inputs = [ config.push-cache-effect.cachix-pkg ];
             secretsMap = { token-file = "${cacheOptions.secretName}"; };
             userSetupScript = ''
               cachix authtoken $(readSecretString token-file .token)

From 275eaa5ba5d7480728f7d35d88ab095aaa0bbde8 Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:35:34 +0100
Subject: [PATCH 09/12] Fix path

---
 effects/push-cache/default.nix | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index 6cf5cbd..a04d7c6 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -1,7 +1,7 @@
 { lib, withSystem, config, ... }:
 let pkgs-x86_64-linux = withSystem "x86_64-linux" ({ pkgs, ... }: pkgs);
 in {
-  imports = [ .././flake-module.nix ];
+  imports = [ ../../flake-module.nix ];
 
   options = {
     push-cache-effect = {

From a4888df2a042eea8c3b19fd5dd7ac82495b80b34 Mon Sep 17 00:00:00 2001
From: zmrocze <karolochmanmilarski@gmail.com>
Date: Mon, 18 Dec 2023 18:41:11 +0100
Subject: [PATCH 10/12] Rename and unformat

---
 effects/push-cache/default.nix | 18 ++++++++++++++----
 flake-public-outputs.nix       |  2 +-
 2 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index a04d7c6..bf16de8 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -32,10 +32,20 @@ in {
           ''Version of the cachix package to use on "x86_64-linux".'';
       };
       caches = lib.mkOption {
-        description =
-          "\n          An attribute set, each `name: value` pair translates to an effect under\n          onPush.default.outputs.effects.push-cache-effect.name\n        ";
-        example =
-          "\n          {\n            our-cachix = {\n              type = \"cachix\";\n              secretName = \"our-cachix-token\";\n              branches = [ \"master\" ];\n              packages = [ pkgs.hello ];\n            };\n          }\n        ";
+        description = ''
+          An attribute set, each `name: value` pair translates to
+          an effect under `onPush.default.outputs.effects.push-cache-effect.name`.
+        '';
+        example = ''
+          {
+            our-cachix = {
+              type = \"cachix\";
+              secretName = \"our-cachix-token\";
+              branches = [ \"master\" ];
+              packages = [ pkgs.hello ];
+            };
+          }
+        '';
         type = lib.types.attrsOf (lib.types.submodule ({ name, ... }: {
           options = {
             name = lib.mkOption {
diff --git a/flake-public-outputs.nix b/flake-public-outputs.nix
index ce64fae..9f0746c 100644
--- a/flake-public-outputs.nix
+++ b/flake-public-outputs.nix
@@ -8,7 +8,7 @@
 
     flakeModule = ./flake-module.nix;
 
-    push-cache-module = ./effects/push-cache;
+    push-cache-effect = ./effects/push-cache;
 
     lib.withPkgs = pkgs:
       let effects = import ./effects/default.nix effects pkgs;

From f5ed263ab0585dfb7b067301419fb80d64e8c021 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A1rton=20Boros?= <martonboros@gmail.com>
Date: Tue, 6 Feb 2024 02:48:57 +0000
Subject: [PATCH 11/12] change attic server name to "default"

---
 effects/push-cache/default.nix | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index bf16de8..5c55083 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -109,14 +109,14 @@ in {
             secretsMap = { token-file = "${cacheOptions.secretName}"; };
             userSetupScript = ''
               attic login \
-                server-name \
+                default \
                 $(readSecretString token-file .endpoint) \
                 $(readSecretString token-file .token)
             '';
             effectScript = ''
               cat ${
                 packagesFile pkgs cacheOptions.packages
-              } | xargs -s 4096 attic push server-name:$(readSecretString token-file .name)
+              } | xargs -s 4096 attic push default:$(readSecretString token-file .name)
             '';
           };
         in hci-effects.runIf ((cacheOptions.branches == null)

From 5ad8f9613b735cb4f8222f07ae45ca37bfe76a23 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A1rton=20Boros?= <martonboros@gmail.com>
Date: Thu, 2 May 2024 18:59:53 +0000
Subject: [PATCH 12/12] fix push-cache-effect when type=cachix branches=null

---
 effects/push-cache/default.nix | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/effects/push-cache/default.nix b/effects/push-cache/default.nix
index 5c55083..1a9f2e9 100644
--- a/effects/push-cache/default.nix
+++ b/effects/push-cache/default.nix
@@ -137,8 +137,8 @@ in {
               } | cachix push $(readSecretString token-file .name)
             '';
           };
-        in hci-effects.runIf (builtins.elem branch cacheOptions.branches)
-        pushEffect);
+        in hci-effects.runIf ((cacheOptions.branches == null)
+          || (builtins.elem branch cacheOptions.branches)) pushEffect);
   in lib.mkIf config.push-cache-effect.enable {
     herculesCI = herculesConfig: {
       onPush.default.outputs.effects.push-cache-effect = lib.attrsets.mapAttrs'