confctl 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94823b33bdeb90ed8aa1a2aa835e8a3f48300c116ee951c3d41e8c433e9ea1ed
-  data.tar.gz: 7ec55e71a411a0844a687047d797c0324efeeb2b2f2fd1dd5efa3261ede6a184
+  metadata.gz: bd99990731daa837f1243feb4a3b098320180badbbb9cc3846c105e7b747b794
+  data.tar.gz: 2ab400c25ea0bfc35f53713826b0e69aeff4667314048aaf6f8f56c942dda4e3
 SHA512:
-  metadata.gz: 83cf4e6ef92ec1cf76f2b260e689a45b52dc3653c35d82bdddabb3246e37b0ddb5d056ad60ebed5506e72612f235e7a283d9eecd29b1822482013ffa1562037a
-  data.tar.gz: aa12794664afe5a91595f91da89e8fe7d8e7205ad4428918bf0e0047ea2f1603244f3fb7aec458d0d0f2e5fdef21add41d431136b6872ec2ae26fe401258111e
+  metadata.gz: 7b2f85762c2c9c8173ffc38fd1fd6c37e2866ae8a6d5a4d1cbfc6d4cbbb8e8037dc9e9d40d0d8f9f12f7a0eae7140c4c52f435ea6e952327803024a6cd08720b
+  data.tar.gz: a3f87cfe12b26ef6c0a520030256a798418b85cee9dbedc2cd63e35b7625aa7e763c4f3d07f9e194826c6d3cffd5f12bc1a55d04201c6963067412a5010c4bad

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# Fri Jun 06 2025 -- version 2.2.0
+- Handle `pkgs.substituteAll` / `pkgs.replaceVarsWith` compatibility on NixOS unstable
+  and 25.05
+- Change swpin files only when revisions are updated, skip commit when no changes were made
+- Add option `--[no-]editor` to `confctl swpins core/cluster/channel set/update` commands
+
 # Sun May 11 2025 -- version 2.1.0
 - Support for referring to generations by their offset
 - Resolved generations are printed on build/deploy/etc.

data/Gemfile

@@ -1,2 +1,8 @@
 source 'https://rubygems.org'
 gemspec
+
+group :development do
+  gem 'overcommit'
+  gem 'rubocop', '~> 1.75.0'
+  gem 'rubocop-rake'
+end

data/lib/confctl/cli/app.rb

@@ -537,6 +537,9 @@ module ConfCtl::Cli
         c.desc 'Include changelog in the commit message'
         c.switch :changelog, default_value: true
 
+        c.desc 'Open $EDITOR with commit message'
+        c.switch :editor, default_value: true
+
         c.desc 'Generate changelog for downgrade'
         c.switch %i[d downgrade], default_value: false
 

data/lib/confctl/cli/swpins/channel.rb

@@ -37,11 +37,12 @@ module ConfCtl::Cli
 
       channels.each(&:save)
 
-      return unless opts[:commit]
+      return if !opts[:commit] || !change_set.any_changes?
 
       change_set.commit(
         type: opts[:downgrade] ? :downgrade : :upgrade,
-        changelog: opts[:changelog]
+        changelog: opts[:changelog],
+        editor: opts[:editor]
       )
     end
 
@@ -62,11 +63,12 @@ module ConfCtl::Cli
 
       channels.each(&:save)
 
-      return unless opts[:commit]
+      return if !opts[:commit] || !change_set.any_changes?
 
       change_set.commit(
         type: opts[:downgrade] ? :downgrade : :upgrade,
-        changelog: opts[:changelog]
+        changelog: opts[:changelog],
+        editor: opts[:editor]
       )
     end
   end

data/lib/confctl/cli/swpins/cluster.rb

@@ -42,11 +42,12 @@ module ConfCtl::Cli
 
       cluster_names.each(&:save)
 
-      return unless opts[:commit]
+      return if !opts[:commit] || !change_set.any_changes?
 
       change_set.commit(
         type: opts[:downgrade] ? :downgrade : :upgrade,
-        changelog: opts[:changelog]
+        changelog: opts[:changelog],
+        editor: opts[:editor]
       )
     end
 
@@ -69,11 +70,12 @@ module ConfCtl::Cli
 
       cluster_names.each(&:save)
 
-      return unless opts[:commit]
+      return if !opts[:commit] || !change_set.any_changes?
 
       change_set.commit(
         type: opts[:downgrade] ? :downgrade : :upgrade,
-        changelog: opts[:changelog]
+        changelog: opts[:changelog],
+        editor: opts[:editor]
       )
     end
   end

data/lib/confctl/cli/swpins/core.rb

@@ -46,11 +46,12 @@ module ConfCtl::Cli
       core.save
       core.pre_evaluate
 
-      return unless opts[:commit]
+      return if !opts[:commit] || !change_set.any_changes?
 
       change_set.commit(
         type: opts[:downgrade] ? :downgrade : :upgrade,
-        changelog: opts[:changelog]
+        changelog: opts[:changelog],
+        editor: opts[:editor]
       )
     end
 
@@ -75,11 +76,12 @@ module ConfCtl::Cli
       core.save
       core.pre_evaluate
 
-      return unless opts[:commit]
+      return if !opts[:commit] || !change_set.any_changes?
 
       change_set.commit(
         type: opts[:downgrade] ? :downgrade : :upgrade,
-        changelog: opts[:changelog]
+        changelog: opts[:changelog],
+        editor: opts[:editor]
       )
     end
   end

data/lib/confctl/swpins/change_set.rb

@@ -48,22 +48,29 @@ module ConfCtl
 
     # @param type [:upgrade, :downgrade]
     # @param changelog [Boolean]
-    def commit(type: :upgrade, changelog: false)
+    # @param editor [Boolean]
+    def commit(type: :upgrade, changelog: false, editor: true)
       return if @owners.empty?
 
-      ret = Kernel.system(
+      git_commit = [
         'git',
         'commit',
-        '-e',
+        editor ? '-e' : nil,
         '-m', build_message(type, changelog),
         *changed_files
-      )
+      ].compact
+
+      ret = Kernel.system(*git_commit)
 
       return if ret
 
       raise 'git commit exited with non-zero status code'
     end
 
+    def any_changes?
+      @owners.any? { |_, spec_sets| spec_sets.any?(&:changed?) }
+    end
+
     protected
 
     def build_message(type, changelog)

data/lib/confctl/swpins/specs/git.rb

@@ -90,14 +90,18 @@ module ConfCtl
       raise "nix-prefetch-git failed with status #{$?.exitstatus}" if $?.exitstatus != 0
 
       ret = JSON.parse(json.strip)
-      self.state = {
-        'rev' => ret['rev'],
-        'date' => Time.now.iso8601
-      }
-      self.info = {
-        'rev' => ret['rev'],
-        'sha256' => ret['sha256']
-      }
+
+      if state.nil? || state['rev'] != ret['rev']
+        self.state = {
+          'rev' => ret['rev'],
+          'date' => Time.now.iso8601
+        }
+        self.info = {
+          'rev' => ret['rev'],
+          'sha256' => ret['sha256']
+        }
+      end
+
       ret
     end
 
@@ -111,14 +115,17 @@ module ConfCtl
 
       raise "nix-prefetch-url failed with status #{$?.exitstatus}" if $?.exitstatus != 0
 
-      self.state = {
-        'rev' => rev,
-        'date' => Time.now.iso8601
-      }
-      self.info = {
-        'rev' => rev,
-        'sha256' => hash
-      }
+      if state.nil? || state['rev'] != rev
+        self.state = {
+          'rev' => rev,
+          'date' => Time.now.iso8601
+        }
+        self.info = {
+          'rev' => rev,
+          'sha256' => hash
+        }
+      end
+
       { 'url' => url, 'sha256' => hash }
     end
 

data/lib/confctl/version.rb

@@ -1,3 +1,3 @@
 module ConfCtl
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/man/man8/confctl.8

@@ -549,6 +549,9 @@ on the type of the software pin, for git it is a git reference, e.g. a revision.
     Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
     default.
 .TP
+\fB\fC\-\-[no]\-editor\fR
+    Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
+.TP
 \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
     Use when the new version is older than the previously set version. Used for
     generating changelog for the commit message.
@@ -563,6 +566,9 @@ this command. The usual case for git is to pin to the current branch head.
     \fB\fC\-\-[no\-]changelog\fR
       Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
       default.
+.PP
+    \fB\fC\-\-[no]\-editor\fR
+      Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
 .PP
     \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
       Use when the new version is older than the previously set version. Used for
@@ -582,6 +588,9 @@ reference, e.g. a revision.
     \fB\fC\-\-[no\-]changelog\fR
       Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
       default.
+.PP
+    \fB\fC\-\-[no]\-editor\fR
+      Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
 .PP
     \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
       Use when the new version is older than the previously set version. Used for
@@ -598,6 +607,9 @@ branch head.
     \fB\fC\-\-[no\-]changelog\fR
       Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
       default.
+.PP
+    \fB\fC\-\-[no]\-editor\fR
+      Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
 .PP
     \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
       Use when the new version is older than the previously set version. Used for
@@ -617,6 +629,9 @@ reference, e.g. a revision.
     \fB\fC\-\-[no\-]changelog\fR
       Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
       default.
+.PP
+    \fB\fC\-\-[no]\-editor\fR
+      Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
 .PP
     \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
       Use when the new version is older than the previously set version. Used for
@@ -633,6 +648,9 @@ branch head.
     \fB\fC\-\-[no\-]changelog\fR
       Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
       default.
+.PP
+    \fB\fC\-\-[no]\-editor\fR
+      Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
 .PP
     \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
       Use when the new version is older than the previously set version. Used for
@@ -648,6 +666,9 @@ in all channels, all machine\-specific pins and the core pins.
     \fB\fC\-\-[no\-]changelog\fR
       Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
       default.
+.PP
+    \fB\fC\-\-[no]\-editor\fR
+      Open \fB\fC$EDITOR\fR with the commit message. Enabled by default.
 .PP
     \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
       Use when the new version is older than the previously set version. Used for

data/man/man8/confctl.8.md

@@ -539,6 +539,9 @@ the generation before last and so on.
     Include changelog in the commit message when `--commit` is used. Enabled by
     default.
 
+  `--[no]-editor`
+    Open `$EDITOR` with the commit message. Enabled by default.
+
   `-d`, `--downgrade`
     Use when the new version is older than the previously set version. Used for
     generating changelog for the commit message.
@@ -554,6 +557,9 @@ the generation before last and so on.
       Include changelog in the commit message when `--commit` is used. Enabled by
       default.
 
+    `--[no]-editor`
+      Open `$EDITOR` with the commit message. Enabled by default.
+
     `-d`, `--downgrade`
       Use when the new version is older than the previously set version. Used for
       generating changelog for the commit message.
@@ -573,6 +579,9 @@ the generation before last and so on.
       Include changelog in the commit message when `--commit` is used. Enabled by
       default.
 
+    `--[no]-editor`
+      Open `$EDITOR` with the commit message. Enabled by default.
+
     `-d`, `--downgrade`
       Use when the new version is older than the previously set version. Used for
       generating changelog for the commit message.
@@ -589,6 +598,9 @@ the generation before last and so on.
       Include changelog in the commit message when `--commit` is used. Enabled by
       default.
 
+    `--[no]-editor`
+      Open `$EDITOR` with the commit message. Enabled by default.
+
     `-d`, `--downgrade`
       Use when the new version is older than the previously set version. Used for
       generating changelog for the commit message.
@@ -608,6 +620,9 @@ the generation before last and so on.
       Include changelog in the commit message when `--commit` is used. Enabled by
       default.
 
+    `--[no]-editor`
+      Open `$EDITOR` with the commit message. Enabled by default.
+
     `-d`, `--downgrade`
       Use when the new version is older than the previously set version. Used for
       generating changelog for the commit message.
@@ -624,6 +639,9 @@ the generation before last and so on.
       Include changelog in the commit message when `--commit` is used. Enabled by
       default.
 
+    `--[no]-editor`
+      Open `$EDITOR` with the commit message. Enabled by default.
+
     `-d`, `--downgrade`
       Use when the new version is older than the previously set version. Used for
       generating changelog for the commit message.
@@ -639,6 +657,9 @@ the generation before last and so on.
       Include changelog in the commit message when `--commit` is used. Enabled by
       default.
 
+    `--[no]-editor`
+      Open `$EDITOR` with the commit message. Enabled by default.
+
     `-d`, `--downgrade`
       Use when the new version is older than the previously set version. Used for
       generating changelog for the commit message.

data/nix/evaluator.nix

@@ -84,11 +84,28 @@ let
     in {
       attribute = result;
 
-      autoRollback = corePkgs.substituteAll {
-        src = ../libexec/auto-rollback.rb;
-        isExecutable = true;
-        ruby = nixpkgs.ruby;
-      };
+      autoRollback =
+        # pkgs.substituteAll was removed from nixos-unstable, but pkgs.replaceVarsWith
+        # is not available in nixos-25.05.
+        let
+          args = {
+            src = ../libexec/auto-rollback.rb;
+            isExecutable = true;
+          };
+
+          replacements = {
+            ruby = nixpkgs.ruby;
+          };
+        in
+          if builtins.hasAttr "replaceVarsWith" corePkgs then
+            corePkgs.replaceVarsWith {
+              inherit (args) src isExecutable;
+              inherit replacements;
+            }
+          else
+            corePkgs.substituteAll ({
+              inherit (args) src isExecutable;
+            } // replacements);
     };
 
   evalMachine = machine:

data/nix/modules/confctl/carrier/base.nix

@@ -4,16 +4,18 @@ let
 
   cfg = config.confctl.carrier;
 
-  carrier-env = pkgs.substituteAll {
+  carrier-env = pkgs.confReplaceVarsWith {
     src = ./carrier-env.rb;
     name = "carrier-env";
     isExecutable = true;
     dir = "bin";
-    ruby = pkgs.ruby;
-    onChangeCommands = pkgs.writeScript "carrier-on-change-commands.sh" ''
-      #!${pkgs.bash}/bin/bash
-      ${cfg.onChangeCommands}
-    '';
+    replacements = {
+      ruby = pkgs.ruby;
+      onChangeCommands = pkgs.writeScript "carrier-on-change-commands.sh" ''
+        #!${pkgs.bash}/bin/bash
+        ${cfg.onChangeCommands}
+      '';
+    };
   };
 in {
   options = {

data/nix/modules/confctl/carrier/netboot/nixos.nix

@@ -52,13 +52,15 @@ let
     isoImages = cfg.isoImages;
   };
 
-  builder = pkgs.substituteAll {
+  builder = pkgs.confReplaceVarsWith {
     src = ./build-netboot-server.rb;
     name = "build-netboot-server";
     dir = "bin";
     isExecutable = true;
-    ruby = pkgs.ruby;
-    jsonConfig = pkgs.writeText "netboot-server.json" builderConfig;
+    replacements = {
+      ruby = pkgs.ruby;
+      jsonConfig = pkgs.writeText "netboot-server.json" builderConfig;
+    };
   };
 in {
   options = {

data/nix/modules/confctl/kexec-netboot/default.nix

@@ -4,13 +4,15 @@ let
 
   cfg = config.confctl.programs.kexec-netboot;
 
-  kexecNetboot = pkgs.substituteAll {
+  kexecNetboot = pkgs.confReplaceVarsWith {
     name = "kexec-netboot";
     src = ./kexec-netboot.rb;
     isExecutable = true;
-    ruby = pkgs.ruby;
-    kexecTools = pkgs.kexec-tools;
-    machineFqdn = confMachine.host.fqdn;
+    replacements = {
+      ruby = pkgs.ruby;
+      kexecTools = pkgs.kexec-tools;
+      machineFqdn = confMachine.host.fqdn;
+    };
   };
 
   kexecNetbootBin = pkgs.runCommand "kexec-netboot-bin" {} ''

data/nix/modules/confctl/overlays.nix

@@ -0,0 +1,15 @@
+{ config, ... }:
+{
+  nixpkgs.overlays = [
+    (self: super: {
+      # nixos-unstable removed pkgs.substituteAll, but nixos-25.05 does not
+      # include the new function pkgs.replaceVarsWith
+      confReplaceVarsWith =
+        { replacements, ... } @ args:
+        if builtins.hasAttr "replaceVarsWith" self then
+          self.replaceVarsWith args
+        else
+          self.substituteAll ((builtins.removeAttrs args [ "replacements" ]) // replacements);
+    })
+  ];
+}

data/nix/modules/module-list.nix

@@ -4,6 +4,7 @@ let
     ./confctl/generations.nix
     ./confctl/cli.nix
     ./confctl/nix.nix
+    ./confctl/overlays.nix
     ./confctl/swpins.nix
   ];
 

data/shell.nix

@@ -19,12 +19,19 @@ in stdenv.mkDerivation rec {
     export GEM_HOME="$(pwd)/.gems"
     BINDIR="$(ruby -e 'puts Gem.bindir')"
     mkdir -p "$BINDIR"
+
     export PATH="$BINDIR:$PATH"
     export RUBYLIB="$GEM_HOME:$CONFCTL/lib"
     export MANPATH="$CONFCTL/man:$(man --path)"
-    gem install --no-document bundler overcommit rubocop
+    gem install --no-document bundler
     pushd "$CONFCTL"
-    bundle install
+
+    # Purity disabled because of prism gem, which has a native extension.
+    # The extension has its header files in .gems, which gets stripped but
+    # cc wrapper in Nix. Without NIX_ENFORCE_PURITY=0, we get prism.h not found
+    # error.
+    NIX_ENFORCE_PURITY=0 bundle install
+
     bundle exec rake md2man:man
     popd
 

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: confctl
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jakub Skokan
-autorequire:
 bindir: bin
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
@@ -331,17 +330,16 @@ files:
 - nix/modules/confctl/kexec-netboot/kexec-netboot.8.adoc
 - nix/modules/confctl/kexec-netboot/kexec-netboot.rb
 - nix/modules/confctl/nix.nix
+- nix/modules/confctl/overlays.nix
 - nix/modules/confctl/swpins.nix
 - nix/modules/module-list.nix
 - nix/modules/system-list.nix
 - shell.nix
 - template/confctl-options.nix/main.erb
 - template/confctl-options.nix/options.erb
-homepage:
 licenses:
 - GPL-3.0-only
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -356,8 +354,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Nix deployment management tool
 test_files: []