pdk 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9684e766d6debf57befee1e394ab0302121b091d910a673665b96f879cb910d
-  data.tar.gz: 4b9aa80e2c4b57a6c5fce2bd67a6b9b78a6143ca8c9f7d47f15ce2e80ca4ea11
+  metadata.gz: c39902d0ebbac37358fd3fccf5de760b47f77860054b08864ccdae63150b7597
+  data.tar.gz: 6a4d8beb3013edf1ed946b9cf94cd90b055ad63500102e131734600c81c3a5a5
 SHA512:
-  metadata.gz: b9635f26c76cff37e9d474a06e844cfc48cc16eb4f3e0367811b2a29e8cf997ff58b10ecec83325b1ae9826a53156fa6da4303667fab481d1cdeaf3e5c753640
-  data.tar.gz: e8c2cc3bde2e7c5a5142521d6dece6ef72f16c144f94dcf009900bad7f52ac1c0e3656e9e5d5f9636d5e5ddfb0c719e08dca9f4bcc86ad26791610374f91bc40
+  metadata.gz: 7af78ce8b0c4bb9122081a2c6449d862da04c9fec85d428b2e8ace3e88a74930fcf809462062b07994307c54c3ee5a827a83ae26e5c67b95f659c3f5c0cb89b5
+  data.tar.gz: c5af71c375d94c9e22f4c7ae284213a39aaa87b8bc21980580ce4e79743979d4cbb967f330c775dcd2ebc4d3046c4c9c5080480172e07dec33afd9546b94da7e

data/CHANGELOG.md

@@ -5,15 +5,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
-## [v3.0.0](https://github.com/puppetlabs/pdk/tree/v3.0.0) - 2023-07-04
+## [v3.0.1](https://github.com/puppetlabs/pdk/tree/v3.0.1) - 2023-12-07
 
-[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.7.1...v3.0.0)
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.0.0...v3.0.1)
 
-### Added
+### Fixed
 
-- (CONT-1053) Update bundle command [#1255](https://github.com/puppetlabs/pdk/pull/1255) ([chelnak](https://github.com/chelnak))
-- (ISS-1123) Verbose output w/ junit file [#1246](https://github.com/puppetlabs/pdk/pull/1246) ([coreymbe](https://github.com/coreymbe))
-- Take "operatingsystem_support" parameter from answer.json [#1165](https://github.com/puppetlabs/pdk/pull/1165) ([me-minus](https://github.com/me-minus))
+- (CAT-345) Update doc links where needed [#1285](https://github.com/puppetlabs/pdk/pull/1285) ([david22swan](https://github.com/david22swan))
+- (CAT-270) Adjusting expected Puppet/Ruby versions [#1283](https://github.com/puppetlabs/pdk/pull/1283) ([LukasAud](https://github.com/LukasAud))
+- (maint) - add stricter puppetlabs_spec_helper dependency [#1280](https://github.com/puppetlabs/pdk/pull/1280) ([jordanbreen28](https://github.com/jordanbreen28))
+- (PUPDOC-5439) Add Trademark icon [#1277](https://github.com/puppetlabs/pdk/pull/1277) ([pmcmaw](https://github.com/pmcmaw))
+
+## [v3.0.0](https://github.com/puppetlabs/pdk/tree/v3.0.0) - 2023-07-04
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v2.7.1...v3.0.0)
 
 ### Changed
 - (CONT-1134) Bump PDK Templates REF [#1264](https://github.com/puppetlabs/pdk/pull/1264) ([chelnak](https://github.com/chelnak))
@@ -25,6 +30,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - (CONT-755) - Bump gem version [#1240](https://github.com/puppetlabs/pdk/pull/1240) ([chelnak](https://github.com/chelnak))
 - (CONT-755) Ruby 3 / Puppet 8 support [#1230](https://github.com/puppetlabs/pdk/pull/1230) ([chelnak](https://github.com/chelnak))
 
+### Added
+
+- (CONT-1053) Update bundle command [#1255](https://github.com/puppetlabs/pdk/pull/1255) ([chelnak](https://github.com/chelnak))
+- (ISS-1123) Verbose output w/ junit file [#1246](https://github.com/puppetlabs/pdk/pull/1246) ([coreymbe](https://github.com/coreymbe))
+- Take "operatingsystem_support" parameter from answer.json [#1165](https://github.com/puppetlabs/pdk/pull/1165) ([me-minus](https://github.com/me-minus))
+
 ### Fixed
 
 - (CONT-1069) Update compatibility handling [#1259](https://github.com/puppetlabs/pdk/pull/1259) ([chelnak](https://github.com/chelnak))

data/README.md

@@ -1,6 +1,8 @@
 # pdk
 
-[![ci](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml) [![Gem Version](https://badge.fury.io/rb/pdk.svg)](https://badge.fury.io/rb/pdk)
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/pdk/blob/main/CODEOWNERS)
+[![ci](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/pdk/actions/workflows/ci.yml) 
+[![Gem Version](https://badge.fury.io/rb/pdk.svg)](https://badge.fury.io/rb/pdk)
 
 * [Installation](#installation)
 * [Basic usage](#basic-usage)
@@ -96,7 +98,7 @@ This command validates the metadata, Puppet code syntax and style, and Ruby synt
 
 ### Run unit tests
 
-PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/rodjek/rspec-puppet/) for catalog-level unit testing.
+PDK's [default template](https://github.com/puppetlabs/pdk-templates) sets up [rspec](http://rspec.info/) for Ruby-level unit testing, and [rspec-puppet](https://github.com/puppetlabs/rspec-puppet/) for catalog-level unit testing.
 
 In the module's directory, run unit tests with:
 
@@ -114,6 +116,10 @@ This command runs all available unit tests.
 
 PDK encourages community contributions. See the [CONTRIBUTING.md](CONTRIBUTING.md) file for development notes.
 
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
+
 ## Contact Information
 
 * [For reporting bugs](https://github.com/puppetlabs/pdk/blob/main/CONTRIBUTING.md#reporting-bugs)

data/lib/pdk/cli/util/option_normalizer.rb

@@ -44,7 +44,7 @@ module PDK
               target = PDK::Report.default_target
             end
 
-            { method: "write_#{format}".to_sym, target: target }
+            { method: :"write_#{format}", target: target }
           end
         end
       end

data/lib/pdk/config/namespace.rb

@@ -217,7 +217,9 @@ module PDK
       # @api private
       def read_only!
         @read_only = true
-        @mounts.each { |_, child| child.read_only! }
+        # pass the read_only! method as a block to the each_value method. This means that
+        # for each value in the @mounts hash, the read_only! method will be called on that value.
+        @mounts.each_value(&:read_only!)
       end
 
       private

data/lib/pdk/report.rb

@@ -93,13 +93,17 @@ module PDK
     # This report is designed for interactive use by a human and so excludes
     # all passing events in order to be consise.
     #
-    # @param target [#write] an IO object that the report will be written to.
-    #   Defaults to PDK::Report.default_target.
+    # @param target [String, IO] The IO target to write the report to.
+    #   If a String is provided, the report will be written to a file with the given path.
+    #   If an IO object is provided, the report will be written to the IO object.
+    #   If no target is provided, the default target PDK::Report.default_target will be used.
+    #
+    # @return [void]
     def write_text(target = self.class.default_target)
       coverage_report = nil
       report = []
 
-      events.each do |_tool, tool_events|
+      events.each_value do |tool_events|
         tool_events.each do |event|
           if event.rspec_puppet_coverage?
             coverage_report = event.to_text

data/lib/pdk/util/changelog_generator.rb

@@ -33,7 +33,7 @@ module PDK
 
         output = changelog_content
 
-        raise PDK::CLI::ExitWithError, format('The generated changelog contains uncategorized Pull Requests. Please label them and try again. See %{changelog_file} for more details', changelog_file: changelog_file) if output.include?('UNCATEGORIZED PRS; GO LABEL THEM') # rubocop:disable Metrics/LineLength
+        raise PDK::CLI::ExitWithError, format('The generated changelog contains uncategorized Pull Requests. Please label them and try again. See %{changelog_file} for more details', changelog_file: changelog_file) if output.include?('UNCATEGORIZED PRS; GO LABEL THEM') # rubocop:disable Layout/LineLength
 
         output
       end

data/lib/pdk/util/puppet_version.rb

@@ -206,10 +206,14 @@ module PDK
         version.nil? ? nil : { gem_version: version, ruby_version: PDK::Util::RubyVersion.default_ruby_version }
       end
 
+      # Finds the specified requirement in the package cache.
+      #
+      # @param requirement [Gem::Requirement] The requirement to search for.
+      # @return [Hash] A hash containing the gem version and ruby version if found, or nil if not found.
       def find_in_package_cache(requirement)
         require 'pdk/util/ruby_version'
 
-        PDK::Util::RubyVersion.versions.each do |ruby_version, _|
+        PDK::Util::RubyVersion.versions.each_key do |ruby_version|
           PDK::Util::RubyVersion.use(ruby_version)
           version = PDK::Util::RubyVersion.available_puppet_versions.find { |r| requirement.satisfied_by?(r) }
           return { gem_version: version, ruby_version: ruby_version } unless version.nil?

data/lib/pdk/util.rb

@@ -95,7 +95,7 @@ module PDK
     def development_mode?
       require 'pdk/util/version'
 
-      (!PDK::Util::Version.git_ref.nil? || PDK::VERSION.end_with?('.pre'))
+      !PDK::Util::Version.git_ref.nil? || PDK::VERSION.end_with?('.pre')
     end
     module_function :development_mode?
 

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '3.0.0'.freeze
-  TEMPLATE_REF = '3.0.0'.freeze
+  VERSION = '3.0.1'.freeze
+  TEMPLATE_REF = '3.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler