Create config.yml as a central place to set the initial config

Author: Pandapip1

.github/workflows/build.yml

@@ -15,25 +15,6 @@ jobs:
   tests:
     strategy:
       matrix:
-        # Set this to notify the global nur package registry that changes are
-        # available.
-        #
-        # The repo name as used in
-        # https://github.com/nix-community/NUR/blob/master/repos.json
-        nurRepo:
-          - <YOUR_REPO_NAME>
-        # Set this to cache your build results in cachix for faster builds
-        # in CI and for everyone who uses your cache.
-        #
-        # Format: Your cachix cache host name without the ".cachix.org" suffix.
-        # Example: mycache (for mycache.cachix.org)
-        #
-        # For this to work, you also need to set the CACHIX_SIGNING_KEY or
-        # CACHIX_AUTH_TOKEN secret in your repository secrets settings in
-        # Github found at
-        # https://github.com/<your_githubname>/nur-packages/settings/secrets
-        cachixName:
-          - <YOUR_CACHIX_NAME>
         nixPath:
           - nixpkgs=https://github.com/NixOS/nixpkgs/archive/refs/heads/nixpkgs-unstable.tar.gz
           - nixpkgs=https://github.com/NixOS/nixpkgs/archive/refs/heads/nixos-unstable.tar.gz
@@ -42,23 +23,39 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+
       - name: Install nix
         uses: cachix/install-nix-action@v31
         with:
           nix_path: "${{ matrix.nixPath }}"
           extra_nix_config: |
             experimental-features = nix-command flakes
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Get config.yml
+        id: config
+        shell: python
+        run: |
+          import yaml, os
+
+          with open("config.yml") as f:
+            data = yaml.safe_load(f)
+
+          with open(os.environ["GITHUB_OUTPUT"], "a") as out:
+            out.write(f"cachixName={data.get('cachixName', '')}\n")
+            out.write(f"nurRepo={data.get('nurRepo', '')}\n")
+
       - name: Show nixpkgs version
         run: nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
+
       - name: Setup cachix
         uses: cachix/cachix-action@v16
-        # Don't replace <YOUR_CACHIX_NAME> here!
-        if: ${{ matrix.cachixName != '<YOUR_CACHIX_NAME>' }}
+        if: ${{ steps.config.outputs.cachixName != '<YOUR_CACHIX_NAME>' }}
         with:
-          name: ${{ matrix.cachixName }}
+          name: ${{ steps.config.outputs.cachixName }}
           signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+
       - name: Check evaluation
         run: |
           nix-env -f . -qa \* --meta --xml \
@@ -67,9 +64,10 @@ jobs:
             --drv-path --show-trace \
             -I nixpkgs=$(nix-instantiate --find-file nixpkgs) \
             -I $PWD
+
       - name: Build nix packages
-        run: nix shell -f '<nixpkgs>' nix-build-uncached -c nix-build-uncached ci.nix -A cacheOutputs
+        run: nix shell -f '<nixpkgs>' nix-build-uncached -c nix-build-uncached maintainers/ci.nix -A cacheOutputs
+
       - name: Trigger NUR update
-        # Don't replace <YOUR_REPO_NAME> here!
-        if: ${{ matrix.nurRepo != '<YOUR_REPO_NAME>' }}
+        if: ${{ steps.config.outputs.nurRepo != '<YOUR_REPO_NAME>' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') }}
         run: curl -XPOST "https://nur-update.nix-community.org/update?repo=${{ matrix.nurRepo }}"

README.md

@@ -12,8 +12,7 @@ An opinionated template for [NUR](https://github.com/nix-community/NUR) reposito
      attribute, or CI (and consequently caching) will fail!
    * Library functions, modules and overlays go in the respective directories
 3. Configure CI: Change your NUR repo name and optionally add a cachix name in
-   [.github/workflows/build.yml](./.github/workflows/build.yml) and change the
-   cron timer to a random value as described in the file.
+   [CMakeLists.txt](./CMakeLists.txt).
 4. Change your cachix name on the README template section and delete the rest
 5. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository) <!-- markdownlint-disable-line MD013 -->
 
@@ -24,4 +23,4 @@ My personal [NUR](https://github.com/nix-community/NUR) repository
 
 ![Build and populate cache](https://github.com/<YOUR-GITHUB-USER>/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
 
-[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)
+[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_NAME>-blue.svg)](https://<YOUR_CACHIX_NAME>.cachix.org)

README.md.j2

@@ -0,0 +1,27 @@
+{% if not setupComplete %}# nur-packages-template
+
+An opinionated template for [NUR](https://github.com/nix-community/NUR) repositories
+
+## Setup
+
+1. Click on [Use this template](https://github.com/nix-community/nur-packages-template/generate) <!-- markdownlint-disable-line MD013 -->
+   to start a repo based on this template. (Do _not_ fork it.)
+2. Add your packages to the [pkgs](./pkgs) directory and to
+   [default.nix](./default.nix)
+   * Remember to mark the broken packages as `broken = true;` in the `meta`
+     attribute, or CI (and consequently caching) will fail!
+   * Library functions, modules and overlays go in the respective directories
+3. Configure: Change your NUR repo name, fill in your GitHub username, and
+   optionally add a cachix name in [CMakeLists.txt](./CMakeLists.txt).
+4. Run `nix run .#maintainers.render_templates` to regenerate the README
+5. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository) <!-- markdownlint-disable-line MD013 -->
+
+<!-- markdownlint-disable-next-line MD025 -->{% endif %}
+# nur-packages
+
+My personal [NUR](https://github.com/nix-community/NUR) repository
+
+![Build and populate cache](https://github.com/{{ githubUser }}/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
+
+[![Cachix Cache](https://img.shields.io/badge/cachix-{{ cachixName }}-blue.svg)](https://{{ cachixName }}.cachix.org)
+

config.yml

@@ -0,0 +1,24 @@
+# Set this to true to disable the setup instructions in the README
+setupComplete: false
+
+# Set this to your github username
+githubUser: "<YOUR-GITHUB-USER>"
+
+# Set this to notify the global nur package registry that changes are
+# available.
+#
+# The repo name as used in
+# https://github.com/nix-community/NUR/blob/master/repos.json
+nurRepo: "<YOUR_REPO_NAME>"
+
+# Set this to cache your build results in cachix for faster builds
+# in CI and for everyone who uses your cache.
+#
+# Format: Your cachix cache host name without the ".cachix.org" suffix.
+# Example: mycache (for mycache.cachix.org)
+#
+# For this to work, you also need to set the CACHIX_SIGNING_KEY or
+# CACHIX_AUTH_TOKEN secret in your repository secrets settings in
+# Github found at
+# https://github.com/<your_githubname>/nur-packages/settings/secrets
+cachixName: "<YOUR_CACHIX_NAME>"

flake.nix

@@ -122,6 +122,26 @@
           {
             legacyPackages = (self.fromPkgs pkgs) // {
               inherit (self) lib overlays modules;
+
+              # Maintenance scripts
+              # TODO: Move this out of the flake
+              maintainers.render_templates = pkgs.stdenvNoCC.mkDerivation {
+                name = "render_templates";
+
+                src = self;
+
+                nativeBuildInputs = [ pkgs.makeWrapper ];
+
+                installPhase = ''
+                  runHook preInstall
+
+                  mkdir -p $out/bin
+                  makeWrapper ${pkgs.python3.interpreter} $out/bin/render_templates \
+                    --add-flags "${self}/maintainers/scripts/render_templates.py"
+
+                  runHook postInstall
+                '';
+              };
             };
             packages = lib.filterAttrs (_: lib.isDerivation) self'.legacyPackages;
 

ci.nix maintainers/ci.nixci.nix renamed to maintainers/ci.nix

@@ -50,7 +50,7 @@ let
 
   outputsOf = p: map (o: p.${o}) p.outputs;
 
-  nurAttrs = import ./default.nix { inherit pkgs; };
+  nurAttrs = import ../default.nix { inherit pkgs; };
 
   nurPkgs = flattenPkgs (
     listToAttrs (

maintainers/scripts/render_templates.py

@@ -0,0 +1,26 @@
+from jinja2 import Environment, FileSystemLoader
+import os, yaml
+
+def load_config(config_path="config.yml"):
+    with open(config_path, "r") as f:
+        return yaml.safe_load(f)
+
+def render_all_templates(src_dir=".", config_path="config.yml"):
+    context = load_config(config_path)
+    env = Environment(loader=FileSystemLoader(src_dir))
+
+    for root, dirs, files in os.walk(src_dir):
+        for file in files:
+            if file.endswith(".j2"):
+                template_path = os.path.join(root, file)
+                relative_template_path = os.path.relpath(template_path, src_dir)
+                output_path = os.path.splitext(template_path)[0]  # strip .j2
+
+                template = env.get_template(relative_template_path)
+                rendered = template.render(context)
+
+                with open(output_path, "w") as f:
+                    f.write(rendered)
+
+if __name__ == "__main__":
+    render_all_templates()