krane 3.7.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bb4b346e9146186c9e1549f71708707568aa9872a2b7e0e1a0e6fd01e9f4d52
-  data.tar.gz: fb3662468c546ba6717cfd9de125cd4d6ef2caa2269404a618c2152770fc0d3d
+  metadata.gz: 034cf54d143695589902632153ddb65969bae6135c88b076ec023c3c7dc3264a
+  data.tar.gz: 309a1d3c9cf5afad784f48a12d9fe1b13568f1485aec95b0007739a13973932a
 SHA512:
-  metadata.gz: 7a4e23ab9d917f223c6e294a61b26d17791c3554257bbc81a95e5372f1d90af727a13b3bf470008be750fafbb7dbef322486289a2b247e9e60881eff2f4bad15
-  data.tar.gz: b73325f5894e1a9ed67e75d1dc1759ceea4afe58aad5be81f27905bd3d0a10ff38012494c26cf68b06c338cd24367bb8e6d472e7b394aed3f3e0f3dd1ff56546
+  metadata.gz: 44e89c3a956dec061b554f17a38a2e7afc552cf94a5071470baa3f60fb16ae2510f287d9dd8c2f9e9cc92d78fc330be225de62ce43c3be9bb22eab06104076c4
+  data.tar.gz: c9d79cd30d415ea7dc718541921a9c02cb60712fe2d021e22869bb03c0e7608b918f8c285a0362fe19d709780c8c48d4f3b5a3c6ba7fa34d299613421350722a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## next
 
+## 3.7.1
+
+- Add a `--partials-dir` parameter. When provided, this path will be check for partials first, prior to both `./partials` and `../partials` being checked.
+
 ## 3.7.0
 
 - Annotate individual resources with `last-applied-configuration` when using `krane deploy` with `--annotate-individuals`. Previously, eligible resources that were made with `create` or `replace` were applied along with the rest of the resources. However, this causes issues when a mutating admission controller modifies otherwise immutable fields.

data/lib/krane/cli/render_command.rb

@@ -11,6 +11,8 @@ module Krane
                      desc: "[DEPRECATED] Read resources from stdin" },
         "current-sha" => { type: :string, banner: "SHA", desc: "Expose SHA `current_sha` in ERB bindings",
                            lazy_default: '' },
+        "partials-dir" => { type: :string, banner: "partials", required:false, default: nil,
+                            desc: "First directory to look for partials, before checking `./partials` and `../partials`" },
       }
 
       def self.from_options(options)
@@ -32,6 +34,7 @@ module Krane
             current_sha: options['current-sha'],
             filenames: paths,
             bindings: bindings_parser.parse,
+            partials_dir: options['partials-dir'],
           )
           renderer.run!(stream: STDOUT)
         end

data/lib/krane/render_task.rb

@@ -14,11 +14,13 @@ module Krane
     # @param current_sha [String] The SHA of the commit
     # @param filenames [Array<String>] An array of filenames and/or directories containing templates (*required*)
     # @param bindings [Hash] Bindings parsed by Krane::BindingsParser
-    def initialize(logger: nil, current_sha:, filenames: [], bindings:)
+    # @params partials_dir [String] A directory to look for partials, before checking `./partials` and `../partials`
+    def initialize(logger: nil, current_sha:, filenames: [], bindings:, partials_dir: nil)
       @logger = logger || Krane::FormattedLogger.build
       @filenames = filenames.map { |path| File.expand_path(path) }
       @bindings = bindings
       @current_sha = current_sha
+      @partials_dir = partials_dir
     end
 
     # Runs the task, returning a boolean representing success or failure
@@ -58,7 +60,7 @@ module Krane
       @logger.phase_heading("Rendering template(s)")
       count = 0
       template_sets.with_resource_definitions_and_filename(current_sha: @current_sha,
-        bindings: @bindings, raw: true) do |rendered_content, filename|
+        bindings: @bindings, raw: true, partials_dir: @partials_dir) do |rendered_content, filename|
         write_to_stream(rendered_content, filename, stream)
         count += 1
       end

data/lib/krane/renderer.rb

@@ -16,11 +16,14 @@ module Krane
     end
     class PartialNotFound < InvalidTemplateError; end
 
-    def initialize(current_sha:, template_dir:, logger:, bindings: {})
+    def initialize(current_sha:, template_dir:, logger:, bindings: {}, partials_dir: nil)
       @current_sha = current_sha
       @template_dir = template_dir
       @partials_dirs =
         %w(partials ../partials).map { |d| File.expand_path(File.join(@template_dir, d)) }
+      # Prepend the partial_dir to the list of partials_dirs so that the user-provided
+      # directory is used first.
+      @partials_dirs.unshift(File.expand_path(partials_dir)) if partials_dir
       @logger = logger
       @bindings = bindings
       # Max length of podname is only 63chars so try to save some room by truncating sha to 8 chars

data/lib/krane/template_sets.rb

@@ -17,13 +17,14 @@ module Krane
         @render_erb = render_erb
       end
 
-      def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false)
+      def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false, partials_dir: nil)
         if @render_erb
           @renderer = Renderer.new(
             template_dir: @template_dir,
             logger: @logger,
             current_sha: current_sha,
             bindings: bindings,
+            partials_dir: partials_dir,
           )
         end
         with_delayed_exceptions(@files, Krane::InvalidTemplateError) do |filename|
@@ -123,20 +124,21 @@ module Krane
       end
     end
 
-    def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false)
+    def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false, partials_dir: nil)
       with_delayed_exceptions(@template_sets, Krane::InvalidTemplateError) do |template_set|
         template_set.with_resource_definitions_and_filename(
           current_sha: current_sha,
           bindings: bindings,
-          raw: raw
+          raw: raw,
+          partials_dir: partials_dir,
         ) do |r_def, filename|
           yield r_def, filename
         end
       end
     end
 
-    def with_resource_definitions(current_sha: nil, bindings: nil, raw: false)
-      with_resource_definitions_and_filename(current_sha: current_sha, bindings: bindings, raw: raw) do |r_def, _|
+    def with_resource_definitions(current_sha: nil, bindings: nil, raw: false, partials_dir: nil)
+      with_resource_definitions_and_filename(current_sha: current_sha, bindings: bindings, raw: raw, partials_dir: partials_dir) do |r_def, _|
         yield r_def
       end
     end

data/lib/krane/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Krane
-  VERSION = "3.7.0"
+  VERSION = "3.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Katrina Verey
@@ -9,7 +9,7 @@ authors:
 - Kir Shatrov
 bindir: exe
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -525,7 +525,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.5
 specification_version: 4
 summary: A command line tool that helps you ship changes to a Kubernetes namespace
   and understand the result