Update

Signed-off-by: Gavin Didrichsen <[email protected]>

Author: gavindidrichsen

.github/workflows/module_ci.yml

@@ -1,10 +1,10 @@
 # This is a generic workflow for Puppet module CI operations.
 name: "Module CI"
 
-# This environment variable is used by Bundler to authenticate with the private Puppet gem source.
-# The value is received as a secret from the calling workflow and propagated as an environment variable
-# to all steps in this workflow. This approach keeps the authentication token secure while making it
-# available to all Bundler operations.
+# Enables puppetcore module build and test by authenticating Bundler with the private Puppet gem source.  
+# The calling workflow must:  
+# - Set a valid PUPPET_FORGE_TOKEN secret on its repository.
+# - Set ruby_version >= 3.1 to override this workflow's default 2.7; otherwise bundle install will fail.  
 env:
   PUPPET_FORGE_TOKEN: ${{ secrets.PUPPET_FORGE_TOKEN }}
   BUNDLE_RUBYGEMS___PUPPETCORE__PUPPET__COM: "forge-key:${{ secrets.PUPPET_FORGE_TOKEN }}"