Add checkReadme and mention data.nix file

nix-open-org · Feb 22, 2024 · 2a6276d · 2a6276d
1 parent f0f3bfa
commit 2a6276d
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 16 deletions.
diff --git a/data.nix b/data.nix
@@ -9,6 +9,14 @@
 
     Anybody can propose changes with PRs, or open issues to have discussions.
 
+    The `README.md` file is automatically generated from the [`data.nix`](./data.nix) file,
+    so open PRs against that instead.
+
+    You can test your changes locally using
+    ```
+    nix run .#checkReadme
+    ```
+
     The person merging PRs will ensure that the change is implemented, either automatically or manually.
   '';
 

diff --git a/flake.nix b/flake.nix
@@ -18,24 +18,32 @@
             ];
           };
         });
-      packages = eachSystem (pkgs: {
-        updateReadme =
-          let
-            eval = nixpkgs.lib.evalModules {
-              modules = [
-                ./schema.nix
-                ./data.nix
-              ];
-              specialArgs.pkgs = pkgs;
-            };
-          in
-          pkgs.writeShellApplication {
-            name = "update-readme";
+      packages = eachSystem (pkgs:
+        let
+          eval = nixpkgs.lib.evalModules {
+            modules = [
+              ./schema.nix
+              ./data.nix
+            ];
+            specialArgs.pkgs = pkgs;
+          };
+          readmeFile = eval.config.readme;
+        in
+        {
+          checkReadme = pkgs.writeShellApplication {
+            name = "check-readme";
             text = ''
-              gitRoot=$(git rev-parse --show-toplevel)
-              cp ${eval.config.readme} "$gitRoot/README.md"
+              cat ${readmeFile}
             '';
           };
-      });
+          updateReadme =
+            pkgs.writeShellApplication {
+              name = "update-readme";
+              text = ''
+                gitRoot=$(git rev-parse --show-toplevel)
+                cp ${readmeFile} "$gitRoot/README.md"
+              '';
+            };
+        });
     };
 }