Merge pull request #1420 from puppetlabs/release-prep

Release prep v3.4.0

Author: gavindidrichsen

CHANGELOG.md

@@ -5,21 +5,44 @@ 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.3.0](https://github.com/puppetlabs/pdk/tree/v3.3.0) - 2024-09-10
+## [v3.4.0](https://github.com/puppetlabs/pdk/tree/v3.4.0) - 2024-11-25
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.3.0...v3.4.0)
+
+### Added
+
+- (CAT-2141) Update `json-schema` dependency [#1412](https://github.com/puppetlabs/pdk/pull/1412) ([david22swan](https://github.com/david22swan))
+- (CAT-643) Add forge gem upload functionality [#1403](https://github.com/puppetlabs/pdk/pull/1403) ([danadoherty639](https://github.com/danadoherty639))
+
+### Fixed
+
+- (CAT-2162) Remove support for SLES 12 [#1418](https://github.com/puppetlabs/pdk/pull/1418) ([david22swan](https://github.com/david22swan))
+- (CAT-2155) Remove metadata_syntax_validator parser swap to `JSON::Pure` [#1415](https://github.com/puppetlabs/pdk/pull/1415) ([david22swan](https://github.com/david22swan))
+- (CAT-2128) Remove `json_pure` dependency [#1411](https://github.com/puppetlabs/pdk/pull/1411) ([david22swan](https://github.com/david22swan))
+- (maint) Fix Gem::Platform.match() deprecation warning  [#1408](https://github.com/puppetlabs/pdk/pull/1408) ([jhbuchanan45](https://github.com/jhbuchanan45))
+- (CAT-2007) Update http setting cert to setting ca_file [#1398](https://github.com/puppetlabs/pdk/pull/1398) ([david22swan](https://github.com/david22swan))
+- (CAT-2007) Use vendored cert files and VERIFY_PEER wth NET::HTTP on Windows [#1396](https://github.com/puppetlabs/pdk/pull/1396) ([david22swan](https://github.com/david22swan))
+- (CAT-2040) pdk spinner inconsistent on windows [#1394](https://github.com/puppetlabs/pdk/pull/1394) ([alex501212](https://github.com/alex501212))
+
+## [v3.3.0](https://github.com/puppetlabs/pdk/tree/v3.3.0) - 2024-09-11
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.2.0...v3.3.0)
 
-## Added
+### Added
 
+- (CAT-1928) Update Supported OS on new module to match what is expected [#1381](https://github.com/puppetlabs/pdk/pull/1381) ([david22swan](https://github.com/david22swan))
+- (CAT-1896) - Use puppet-modulebuilder for `PDK build` [#1374](https://github.com/puppetlabs/pdk/pull/1374) ([jordanbreen28](https://github.com/jordanbreen28))
 - Skip 'name' validation when in a controlrepo context [#1352](https://github.com/puppetlabs/pdk/pull/1352) ([garrettrowell](https://github.com/garrettrowell))
-- (CAT-1896) - Use puppet-modulebuilder for PDK build [#1374](https://github.com/puppetlabs/pdk/pull/1374) ([jordanbreen28](https://github.com/jordanbreen28))
 
 ### Fixed
 
+- (CAT-2026) Update how `pdk test unit --list` detects an error [#1388](https://github.com/puppetlabs/pdk/pull/1388) ([david22swan](https://github.com/david22swan))
+- Support executable templates on filesystems mounted with `noexec` [#1383](https://github.com/puppetlabs/pdk/pull/1383) ([nabertrand](https://github.com/nabertrand))
+- (CAT-1786) Remove Fedora 36 from the and add Fedora 40 to the PDK README [#1379](https://github.com/puppetlabs/pdk/pull/1379) ([LukasAud](https://github.com/LukasAud))
+- (CAT-648) - Mark release*.rb files as non-executable [#1378](https://github.com/puppetlabs/pdk/pull/1378) ([jordanbreen28](https://github.com/jordanbreen28))
 - (CAT-1643) Update childprocess and remove patch [#1356](https://github.com/puppetlabs/pdk/pull/1356) ([david22swan](https://github.com/david22swan))
-- (CAT-2026) Update how pdk test unit --list detects an error [#1388](https://github.com/puppetlabs/pdk/pull/1388) ([david22swan](https://github.com/david22swan))
 
-## [v3.2.0](https://github.com/puppetlabs/pdk/tree/v3.2.0) - 2024-05-02
+## [v3.2.0](https://github.com/puppetlabs/pdk/tree/v3.2.0) - 2024-05-08
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.1.0...v3.2.0)
 
@@ -57,6 +80,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [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))
 - (CONT-1154) Disable console command [#1263](https://github.com/puppetlabs/pdk/pull/1263) ([chelnak](https://github.com/chelnak))
 - (CONT-1130) Bump PDK gem version [#1260](https://github.com/puppetlabs/pdk/pull/1260) ([chelnak](https://github.com/chelnak))

docs/pdk_known_issues.md

@@ -1,5 +1,26 @@
 # PDK known issues
 
+## PDK 3.4.0 - Issue with utilising bundled templates
+
+We have recently begun seeing an issue with the default bundled templates on certain OSs, with the pdk failing to see them as valid as shown in the below error.
+
+```
+pdk (FATAL): Unable to find a valid module template to use.
+```
+
+Through investigation this seems most likely to be an issue with a dependency brought in throught Git and unfortunately one that we have not been able to resolve in time for this release.
+
+This error is most commonly found when creating a new module or attempting to update a module that was previously created from the default templates, within an airgapped environment.
+
+There is a relatively simple solution to get around this however, though it does require a few extra steps and that is to clone down the pdk-template repo onto your machine and target it manually as shown below.
+
+```
+pdk new module example --template-url=file:///Users/example.user/Github/pdk-templates --template-ref=3.4.0
+pdk update --template-url=file:///Users/example.user/Github/pdk-templates --template-ref=3.4.0
+```
+
+Once the first run has been made, the PDK will store your targeted templates location and so your next run should automatically go to it moving forward, until such time as you target another or clear your .pdk cache.
+
 ## PDK v3.3.0 requires puppet-modulebuilder
 
 With the v3.3.0 release of the PDK, it has been updated to utilise the [puppet-modulebuilder](https://github.com/puppetlabs/puppet-modulebuilder) with the previously existing duplicated internal code having been removed. As such anyone who uses `PDK::Module::Build` in their setup will need to update their own code to do the same.
@@ -14,4 +35,4 @@ For more information on how to correct this known issue see the [PDK Troubleshoo
 
 ## PDK v3.0.1 Cert expired
 
-This issue was resolved and shipped in PDK v3.1.0, if you are seeing an issue in relation to an expired cert, please upgrade the PDK.  
+This issue was resolved and shipped in PDK v3.1.0, if you are seeing an issue in relation to an expired cert, please upgrade the PDK.

docs/release_notes_pdk.md

@@ -2,6 +2,44 @@
 
 New features, enhancements, and resolved issues for PDK.
 
+## PDK 3.4.0
+
+### Deprecations
+
+* Support has been removed for `SLES 12` and packages for it are no being longer built.
+
+### New features and enhancements
+
+* The in built `forge upload` functionality has been replaced with a call to the `puppet_forge` gem.
+* `json-schema` dependency updated so as to `~> 5.0` in order for it to be kept it in line with the wider Puppet products.
+* Support for `RedHat 8` has been extended to `AARCH64` with new packages built.
+
+### Bug Fixes
+
+* A parser swap to `JSON::Pure` has been removed from the `metadata_syntax_validator` changing the output. This is needed as the parser no longer being supported by the `json`/`json_pure` gem.
+* Remove dependency on `json_pure` gem as it is no longer necesary with `json` being added as a default ruby gem.
+* Deprecated call `Gem::Platform.match()` replaced with the modern `Gem::Platform.match_spec?` within `puppet_version.rb`.
+* Update `vendored_file.rb` to use vendored cert files and `VERIFY_PEER` with `NET::HTTP` on Windows machines.
+* The above change to `vendored_file.rb` has been updated to set `http.ca_file` rather than `http.cert`.
+* PDK spinner has been updated on Windows to be more consistent, with tick marks now being given upon success.
+
+### Runtime Changes
+
+* Version of `git` gem bundle within runtime set to `2.39.4`.
+* `json_pure` gem removed from the runtime.
+* `puppet_forge` gem has been added to the runtime pinned to `5.0.4`, with the following dependencies also added:
+  * Dependency `faraday` pinned to `2.12.0`.
+  * Dependency `faraday-follow_redirects` pinned to `0.3.0`.
+  * Dependency `faraday-net_http` pinned to `3.3.0`.
+  * Dependency `semantic_puppet` pinned to `1.1.0`.
+  * Dependency `minitar` already present, pin kept at `0.9`.
+
+### Template Changes
+
+* `puppet_blacksmith` gem has been added to the templates, pinned to `~> 7.0`.
+* `puppetlabs_spec_helper` gem has been repinned to `~> 8.0`.
+* Default `lint` configuration has been updated to match that within `puppetlabs_spec_helper`. Notation added to help ensure they are kept in sync.
+
 ## PDK 3.3.0
 
 ### New features and enhancements
@@ -21,7 +59,6 @@ New features, enhancements, and resolved issues for PDK.
 
 ### Template Changes
 
-* Updated to require `facterdb` 1.26 or newer
 * Bolt-related files added to the .gitignore default paths
 * `puppetlabs_sec_help` pinned to 7.3 or newer and `.rspec.erb` removed to account
 * Pin added for `rexml` to account for Windows issues

lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '3.3.0'.freeze
-  TEMPLATE_REF = '3.3.0.1'.freeze
+  VERSION = '3.4.0'.freeze
+  TEMPLATE_REF = '3.4.0'.freeze
 end