├── .envrc ├── .gitignore ├── .vscode └── extensions.json ├── LICENSE ├── README.md ├── default.nix ├── flake.lock ├── flake.nix └── script.jq /.envrc: -------------------------------------------------------------------------------- 1 | use flake 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.direnv 2 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "jq-syntax-highlighting.jq-syntax-highlighting" 4 | ] 5 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cachix-push 2 | 3 | A flake app to **push and pin** multiple store paths [built by Omnix](https://omnix.page/om/ci.html) to cachix. Better than `nix build ... | cachix push ...`. 4 | 5 | When you pin paths, they are indexed by `system` and custom `prefix` (usually git branch). In CI, you can do this only from say `main` branch, thus having up-to-date cache for your primary branch and have it pinned. 6 | 7 | ## Usage 8 | 9 | Push and pin all store paths built by [`om ci`](https://omnix.page/om/ci.html). First, run `om ci` to build outputs: 10 | 11 | ```sh 12 | # First, build the flake. 13 | om ci run --results=om.json 14 | ``` 15 | 16 | This will create a JSON like: 17 | 18 | ```json 19 | { 20 | "systems": [ 21 | "x86_64-linux" 22 | ], 23 | "result": { 24 | "omnix": { 25 | "build": { 26 | "byName": { 27 | "treefmt-check": "/nix/store/x14rcm3djs4cr9d2ih0msxw8jiwdm1yn-treefmt-check", 28 | "omnix-cli": "/nix/store/ci6vsd9wpd8h3mrjxf7ny4mk1ncjjprc-omnix-cli-0.1.0", 29 | "omnix-devshell": "/nix/store/n4ri7biinnpwx0d5s68vgni6wjlichn1-omnix-devshell", 30 | "rust-flake-devshell": "/nix/store/wcj64d5yv56bd728737rczxkdjwvfibs-rust-flake-devshell" 31 | } 32 | } 33 | }, 34 | } 35 | } 36 | ``` 37 | 38 | (Everything under `byName` represents the store paths of flake output indexed by their derivation name) 39 | 40 | Which can you pass to this program to push & pin on cache: 41 | 42 | ```sh 43 | # Push to https://mycache.cachix.org 44 | nix run github:juspay/cachix-push -- --cache mycache --subflake ROOT --prefix "$(git branch --show-current)" < om.json 45 | ``` 46 | 47 | This will output at the end what got pinned, for example: 48 | 49 | ```text 50 | [..] 51 | Pinning on https://om.cachix.org 52 | Pin main-x86_64-linux-treefmt-check => /nix/store/x14rcm3djs4cr9d2ih0msxw8jiwdm1yn-treefmt-check 53 | Pin main-x86_64-linux-omnix-cli => /nix/store/ci6vsd9wpd8h3mrjxf7ny4mk1ncjjprc-omnix-cli-0.1.0 54 | Pin main-x86_64-linux-omnix-devshell => /nix/store/n4ri7biinnpwx0d5s68vgni6wjlichn1-omnix-devshell 55 | Pin main-x86_64-linux-rust-flake-devshell => /nix/store/wcj64d5yv56bd728737rczxkdjwvfibs-rust-flake-devshell 56 | ``` 57 | 58 | which gets reflected in the cachix UI as: 59 | 60 | ![image](https://github.com/user-attachments/assets/1e392d69-7f22-4c38-946b-e0725d69b1fb) 61 | 62 | ## GitHub workflow example 63 | 64 | - https://github.com/juspay/omnix/pull/340 65 | -------------------------------------------------------------------------------- /default.nix: -------------------------------------------------------------------------------- 1 | { pog, jq, cachix, git, ... }: 2 | 3 | pog.pog { 4 | name = "cachix-push-om-outputs"; 5 | description = "Foo bar"; 6 | flags = [ 7 | { 8 | name = "cache"; 9 | description = "The name of the cachix cache to push to"; 10 | argument = "CACHIX_CACHE"; 11 | } 12 | { 13 | name = "subflake"; 14 | description = "The name of the omnix CI subflake to use"; 15 | argument = "SUBFLAKE"; 16 | } 17 | { 18 | name = "prefix"; 19 | description = "The prefix to use in conjunction with system string when pinning paths"; 20 | argument = "PREFIX"; 21 | } 22 | { 23 | name = "names"; 24 | description = "The list of derivation names to do whitelisted cachix push and pin"; 25 | argument = "NAMES"; 26 | } 27 | ]; 28 | runtimeInputs = [ jq cachix git ]; 29 | strict = true; 30 | script = helpers: '' 31 | blue "Parsing omnix JSON (subflake=$subflake)" 32 | 33 | STORE_PATHS=$(jq -r --arg prefix "$prefix" --arg subflake "$subflake" --arg derivations "$names" -f ${./script.jq}) 34 | 35 | green "Pushing to https://''${cache}.cachix.org" 36 | echo "$STORE_PATHS" | jq -r --arg cache "$cache" '"cachix push \($cache) \(values | join(" "))"' | sh 37 | 38 | green "Pinning on https://''${cache}.cachix.org" 39 | echo "$STORE_PATHS" | jq -r --arg cache "$cache" 'to_entries[] | "echo '"'Pin \(.key) => \(.value)'"'; cachix pin -v \($cache) \(.key) \(.value)"' | sh 40 | ''; 41 | } 42 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "flake-compat": { 4 | "flake": false, 5 | "locked": { 6 | "lastModified": 1696426674, 7 | "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", 8 | "owner": "edolstra", 9 | "repo": "flake-compat", 10 | "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", 11 | "type": "github" 12 | }, 13 | "original": { 14 | "owner": "edolstra", 15 | "repo": "flake-compat", 16 | "type": "github" 17 | } 18 | }, 19 | "flake-parts": { 20 | "inputs": { 21 | "nixpkgs-lib": [ 22 | "nixpkgs" 23 | ] 24 | }, 25 | "locked": { 26 | "lastModified": 1730504689, 27 | "narHash": "sha256-hgmguH29K2fvs9szpq2r3pz2/8cJd2LPS+b4tfNFCwE=", 28 | "owner": "hercules-ci", 29 | "repo": "flake-parts", 30 | "rev": "506278e768c2a08bec68eb62932193e341f55c90", 31 | "type": "github" 32 | }, 33 | "original": { 34 | "owner": "hercules-ci", 35 | "repo": "flake-parts", 36 | "type": "github" 37 | } 38 | }, 39 | "flake-utils": { 40 | "inputs": { 41 | "systems": "systems" 42 | }, 43 | "locked": { 44 | "lastModified": 1726560853, 45 | "narHash": "sha256-X6rJYSESBVr3hBoH0WbKE5KvhPU5bloyZ2L4K60/fPQ=", 46 | "owner": "numtide", 47 | "repo": "flake-utils", 48 | "rev": "c1dfcf08411b08f6b8615f7d8971a2bfa81d5e8a", 49 | "type": "github" 50 | }, 51 | "original": { 52 | "owner": "numtide", 53 | "repo": "flake-utils", 54 | "type": "github" 55 | } 56 | }, 57 | "nixpkgs": { 58 | "locked": { 59 | "lastModified": 1730531603, 60 | "narHash": "sha256-Dqg6si5CqIzm87sp57j5nTaeBbWhHFaVyG7V6L8k3lY=", 61 | "owner": "NixOS", 62 | "repo": "nixpkgs", 63 | "rev": "7ffd9ae656aec493492b44d0ddfb28e79a1ea25d", 64 | "type": "github" 65 | }, 66 | "original": { 67 | "owner": "NixOS", 68 | "ref": "nixos-unstable", 69 | "repo": "nixpkgs", 70 | "type": "github" 71 | } 72 | }, 73 | "pog": { 74 | "inputs": { 75 | "flake-compat": "flake-compat", 76 | "flake-utils": "flake-utils", 77 | "nixpkgs": [ 78 | "nixpkgs" 79 | ] 80 | }, 81 | "locked": { 82 | "lastModified": 1730693909, 83 | "narHash": "sha256-BM9u0TC5m5lJoThoJS8te40mRwKncDK7nhaT2XkJIXE=", 84 | "owner": "jpetrucciani", 85 | "repo": "pog", 86 | "rev": "595caf03131bd93d3f295079a89d595b168ad856", 87 | "type": "github" 88 | }, 89 | "original": { 90 | "owner": "jpetrucciani", 91 | "repo": "pog", 92 | "type": "github" 93 | } 94 | }, 95 | "root": { 96 | "inputs": { 97 | "flake-parts": "flake-parts", 98 | "nixpkgs": "nixpkgs", 99 | "pog": "pog" 100 | } 101 | }, 102 | "systems": { 103 | "locked": { 104 | "lastModified": 1681028828, 105 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", 106 | "owner": "nix-systems", 107 | "repo": "default", 108 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", 109 | "type": "github" 110 | }, 111 | "original": { 112 | "owner": "nix-systems", 113 | "repo": "default", 114 | "type": "github" 115 | } 116 | } 117 | }, 118 | "root": "root", 119 | "version": 7 120 | } 121 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | inputs = { 3 | nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; 4 | flake-parts.url = "github:hercules-ci/flake-parts"; 5 | flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs"; 6 | pog.url = "github:jpetrucciani/pog"; 7 | pog.inputs.nixpkgs.follows = "nixpkgs"; 8 | }; 9 | 10 | outputs = inputs@{ self, nixpkgs, flake-parts, ... }: 11 | flake-parts.lib.mkFlake { inherit inputs; } { 12 | systems = [ "x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin" ]; 13 | perSystem = { pkgs, system, ... }: { 14 | _module.args.pkgs = import nixpkgs { 15 | inherit system; 16 | overlays = [ inputs.pog.overlays.${system}.default ]; 17 | }; 18 | packages.default = pkgs.callPackage ./default.nix { }; 19 | 20 | devShells.default = pkgs.mkShell { 21 | packages = [ 22 | pkgs.nixd # Nix language server 23 | ]; 24 | }; 25 | }; 26 | }; 27 | } 28 | -------------------------------------------------------------------------------- /script.jq: -------------------------------------------------------------------------------- 1 | # Extract store paths along with their name from omnix CI json. Fail if the results encompass more than one system. 2 | # 3 | def get_transformed_key($base_key; $prefix; $sys): 4 | "\($prefix)-\($sys)-\($base_key)"; 5 | 6 | def filter_derivations($name; $derivation_list; $prefix; $sys): 7 | if ($derivation_list | keys | any(. == $name)) 8 | then { 9 | key: get_transformed_key($name; $prefix; $sys), 10 | value: $derivation_list[$name] 11 | } 12 | else 13 | error("No such derivation with name: \($name)") 14 | end; 15 | 16 | # Arguments: 17 | # - $subflake: the subflake to use 18 | # - $prefix: the prefix to use (usually git branch) 19 | # - $derivations: optional list of names to filter by (if empty, all names are included) 20 | if (.systems | length) != 1 21 | then error("systems array must have exactly 1 element") 22 | else .systems[0] as $sys 23 | | ($derivations | split(" ")) as $drvs 24 | | .result[$subflake].build.byName as $byName 25 | | if ($drvs | length) == 0 then 26 | # If no derivations specified, return all entries with transformed keys 27 | $byName 28 | | to_entries 29 | | map({ 30 | key: get_transformed_key(.key; $prefix; $sys), 31 | value: .value 32 | }) 33 | | from_entries 34 | else 35 | # If derivations specified, return only those entries 36 | ($drvs | map(filter_derivations(.; $byName; $prefix; $sys))) 37 | | from_entries 38 | end 39 | end 40 | --------------------------------------------------------------------------------