puppet_metadata 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac5190193748a7ec1f0d61f9c7ef2bac509bb78e1e854b373362e421cf4a656
-  data.tar.gz: dcafc939d26360e09cd7525b72ca2e4268802d2e4103d4c61b14570a4700a402
+  metadata.gz: bbf0cec07a466deb7e97d1e4c20b75087243573b954c8350c605141f534fe1b9
+  data.tar.gz: 3522efe76946069d526bd87ac9023da1b054b0676d4cc0c0b3ac1f476f32c979
 SHA512:
-  metadata.gz: 7e18f077b5298afce2a703c1c1c66d941f447a72740dc29105b57d9cd1cb929ed4c4a537a021950ca4ed2c1cda06eaf40d3f1e8c927f7b05212b1f241e0db331
-  data.tar.gz: b16239f27e4a1c74174816fe1b59bd28f1503f4839fc52bfc952f3c6ce1fe3d70bdccacb138f136e1f75a1423ef1537d574c07b2625bc044a8a12094ade701a6
+  metadata.gz: 6149d30f3403cbf37f17ccb6d132ce15c86eae5e4d3de16d2dbc96362d5b3e82751e229919fe39afc7fa06528873cfea974ec123aed9165ab7f6f3531c205212
+  data.tar.gz: 8d759313fbb484738c39984190d0756712ba0aab483a7f909bebfebc629f9c9b80cf69695bb8690a0c3f23dc3eaa3654f6c80a7cb05b46215d4e89be6494f339

data/README.md

@@ -8,7 +8,8 @@
 [![RubyGem Downloads](https://img.shields.io/gem/dt/puppet_metadata.svg)](https://rubygems.org/gems/puppet_metadata)
 [![Donated by Ewoud Kohl van Wijngaarden](https://img.shields.io/badge/donated%20by-Ewoud%20Kohl%20van%20Wijngaarden-fb7047.svg)](#transfer-notice)
 
-The gem intends to provide an abstraction over Puppet's metadata.json file. Its API allow easy iteration over its illogical data structures.
+The gem intends to provide an abstraction over Puppet's metadata.json file.
+Its API allow easy iteration over its illogical data structures.
 
 - [puppet\_metadata](#puppet_metadata)
   - [New CLI interface in 6.0.0](#new-cli-interface-in-600)
@@ -126,7 +127,8 @@ Debian => 13
 
 ## Generating Github Actions outputs
 
-To get outputs [usable in Github Actions](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions), there is the `metadata2gha` command available. This generates based on metadata.json, such as [Beaker](https://github.com/voxpupuli/beaker) setfiles, Puppet major versions and a Puppet unit test matrix.
+To get outputs [usable in Github Actions](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions), there is the `metadata2gha` command available.
+This generates based on metadata.json, such as [Beaker](https://github.com/voxpupuli/beaker) setfiles, Puppet major versions and a Puppet unit test matrix.
 
 ```console
 $ metadata2gha
@@ -258,6 +260,75 @@ This results in the following JSON data
 ]
 ```
 
+We can also limit the matrix to a specific collection:
+
+```console
+$ metadata2gha --collection openvox8
+```
+
+```
+[
+  {
+    "name": "OpenVox 8 - AlmaLinux 8",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "openvox8",
+      "BEAKER_SETFILE": "almalinux8-64{hostname=almalinux8-64-openvox8}"
+    }
+  },
+  {
+    "name": "OpenVox 8 - AlmaLinux 9",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "openvox8",
+      "BEAKER_SETFILE": "almalinux9-64{hostname=almalinux9-64-openvox8}"
+    }
+  },
+  {
+    "name": "OpenVox 8 - CentOS 9",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "openvox8",
+      "BEAKER_SETFILE": "centos9-64{hostname=centos9-64-openvox8}"
+    }
+  },
+  {
+    "name": "OpenVox 8 - Debian 11",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "openvox8",
+      "BEAKER_SETFILE": "debian11-64{hostname=debian11-64-openvox8}"
+    }
+  }
+]
+```
+
+There is also the special collection `staging`.
+This will generate a matrix for all OS releases with AIO packages.
+The idea is to test unreleased packages.
+
+```
+[
+  {
+    "name": "OpenVox 8 - AlmaLinux 8",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "staging",
+      "BEAKER_SETFILE": "almalinux8-64{hostname=almalinux8-64-staging}"
+    }
+  },
+  {
+    "name": "OpenVox 8 - AlmaLinux 9",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "staging",
+      "BEAKER_SETFILE": "almalinux9-64{hostname=almalinux9-64-staging}"
+    }
+  },
+  {
+    "name": "OpenVox 8 - CentOS 9",
+    "env": {
+      "BEAKER_PUPPET_COLLECTION": "staging",
+      "BEAKER_SETFILE": "centos9-64{hostname=centos9-64-staging}"
+    }
+  }
+]
+```
+
 ## Work with the API
 
 The API can be initialised like this:

data/bin/metadata2gha

@@ -13,6 +13,7 @@ options = {
 OptionParser.new do |opts|
   opts.banner = "Usage: #{$0} [options] metadata"
 
+  opts.on('-c', '--collection VALUE', 'Limit GitHub jobs to only test this specific collection') { |opt| options[:collection] = opt }
   opts.on('-d', '--domain VALUE', 'the domain for the box, only used when --use-fqdn is set to true') { |opt| options[:domain] = opt }
   opts.on('--minimum-major-puppet-version VERSION', "Don't create actions for Puppet versions less than this major version") { |opt| options[:minimum_major_puppet_version] = opt }
   opts.on('--beaker-facter FACT:LABEL:VALUES', 'Expand the matrix based on a fact. Separate values using commas') do |opt|

data/lib/puppet_metadata/github_actions.rb

@@ -56,37 +56,63 @@ module PuppetMetadata
 
     def beaker_os_releases(at = nil)
       majors = beaker_major_versions
-      distro_puppet_version = {
-        name: 'Distro Puppet',
-        value: nil, # We don't know the version and since it's rolling, it can be anything
-        collection: 'none',
-        requirement: 'puppet',
-      }
-      metadata.operatingsystems.each do |os, releases|
-        case os
-        when 'Archlinux', 'Gentoo'
-          # both currently only ship puppet, not openvox yet
-          yield [os, 'rolling', distro_puppet_version]
-        else
+      # for staging, we don't want to have one job per major openvox/puppet version
+      # we just want to pull a specific, unreleased, package from a webserver
+      # and we only do this for AIO builds, because we don't have other packages
+      collection = options[:collection]
+      collection = nil if collection&.empty?
+      if collection == 'staging'
+        latest = majors.first.dup
+        latest[:collection] = 'staging'
+        metadata.operatingsystems.each do |os, releases|
+          # iterates on all releases for one OS
+          # `&` in case the OS has no releases in metadata.json
           releases&.each do |release|
-            if PuppetMetadata::OperatingSystem.eol?(os, release, at)
-              message = "Skipping EOL operating system #{os} #{release}"
-
-              if ENV.key?('GITHUB_ACTIONS')
-                # TODO: determine file and position within the file
-                puts "::warning file=metadata.json::#{message}"
-              else
-                warn message
+            next if PuppetMetadata::OperatingSystem.eol?(os, release, at)
+
+            yield [os, release, latest] if AIO.has_aio_build?(os, release, latest[:value], latest[:requirement])
+          end
+        end
+      else
+        distro_puppet_version = {
+          name: 'Distro Puppet',
+          value: nil, # We don't know the version and since it's rolling, it can be anything
+          collection: 'none',
+          requirement: 'puppet',
+        }
+        metadata.operatingsystems.each do |os, releases|
+          case os
+          when 'Archlinux', 'Gentoo'
+            # we filter out the rolling distributions because we don't know which openvox/puppet version we get and we want a specific collection
+            next if collection
+
+            # both currently only ship puppet, not openvox yet
+            yield [os, 'rolling', distro_puppet_version]
+          else
+            releases&.each do |release|
+              if PuppetMetadata::OperatingSystem.eol?(os, release, at)
+                message = "Skipping EOL operating system #{os} #{release}"
+
+                if ENV.key?('GITHUB_ACTIONS')
+                  # TODO: determine file and position within the file
+                  puts "::warning file=metadata.json::#{message}"
+                else
+                  warn message
+                end
+
+                next
               end
 
-              next
-            end
+              majors.each do |puppet_version|
+                # if a collection is set, it's not 'staging'
+                # we then want to filter out all results that don't match our provided collection
+                next if collection && puppet_version[:collection] != collection
 
-            majors.each do |puppet_version|
-              if AIO.has_aio_build?(os, release, puppet_version[:value], puppet_version[:requirement])
-                yield [os, release, puppet_version]
-              elsif PuppetMetadata::OperatingSystem.os_release_puppet_version(os, release) == puppet_version[:value]
-                yield [os, release, distro_puppet_version.merge(value: puppet_version[:value])]
+                if AIO.has_aio_build?(os, release, puppet_version[:value], puppet_version[:requirement])
+                  yield [os, release, puppet_version]
+                elsif PuppetMetadata::OperatingSystem.os_release_puppet_version(os, release) == puppet_version[:value]
+                  yield [os, release, distro_puppet_version.merge(value: puppet_version[:value])]
+                end
               end
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_metadata
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -118,14 +118,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Data structures for the Puppet Metadata
 test_files: []