r10k 3.7.0 → 3.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b9e50ee8c5d0887c46aaf294074c57626229cb19218fc08dd87f5ae1812888
-  data.tar.gz: 96c59ea0332a86792c6922f354fdf5bed5c9cb31a37b608e09692fbce00cb1bb
+  metadata.gz: 46561d19b47798865a0cb7a986deb0dc5f4fadc9094414ca25958a41395f07fa
+  data.tar.gz: 3d604c77ed0d1735127c18737a1bbb0aacc65ad17a789e4b154e05283e240ac3
 SHA512:
-  metadata.gz: 45e41d47b78d5951e533f6b2dece2f2f127610b6ac6a9d3d95927699eb11369159add33e467198e0b7869442c1803b5e183e02a44c00ccc8eadf43aabf263b8e
-  data.tar.gz: 4790f4189c4e15502cfc633d52605e000a9607acc1b59ec2b011d14736eed3dbcb05333e3bb2817d6bad3e08603c8472267f3a19dca0d64c3f1df10c99eb4200
+  metadata.gz: bfff74f4746cf25caf1586e6cfd4dea01e810203d59dab4de2072d35ba42bd90e5f1e2a904e117c1fba63de20666ab4b98f26ad6552ecfd1b4ce6c814eb65c0b
+  data.tar.gz: 5a3972217637238fd8f9bfd1c810e26a901764b496d7dc195c26a0c567111ab03c621e4cef20564f4c8ef57c6292255a8871625ffe3e15597ba6765d39428002

data/.github/pull_request_template.md

@@ -1,4 +1,4 @@
 Please add all notable changes to the "Unreleased" section of the CHANGELOG in the format:
 ```
-- Summary of changes. [Issue or PR #](link to issue or PR)
+- (JIRA ticket) Summary of changes. [Issue or PR #](link to issue or PR)
 ```

data/.github/workflows/docker.yml

@@ -29,7 +29,10 @@ jobs:
       - run: gem install bundler
       - name: Build container
         working-directory: docker
-        run: make lint build test
+        run: |
+          docker system prune --all --force --volumes
+          docker builder prune --force --keep-storage=10GB
+          make lint build test
       - name: Publish container
         working-directory: docker
         run: |

data/.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Tag and release
 on:
   push:
     branches:
-      - master
+      - main
     paths:
       - 'lib/r10k/version.rb'
 
@@ -15,10 +15,11 @@ jobs:
         with:
           fetch-depth: '0'
       - name: Bump version and push tag
-        uses: anothrNick/github-tag-action@1.17.2
+        uses: anothrNick/github-tag-action@1.35.0
         env:
           GITHUB_TOKEN: ${{ secrets.PUPPET_RELEASE_GH_TOKEN }}
           DEFAULT_BUMP: patch
+          TAG_CONTEXT: branch
           WITH_V: false
           # Uncomment this if the tag and version file become out-of-sync and
           # you need to tag at a specific version.

data/.github/workflows/rspec_tests.yml

@@ -3,7 +3,7 @@ name: Rspec tests
 on:
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   rspec_tests:

data/.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues
+
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v3
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-stale: 60
+        days-before-close: 7
+        stale-issue-message: 'This issue has been marked stale because it has had no activity for 60 days. The Puppet Team is actively prioritizing existing bugs and new features, if this issue is still important to you please comment and we will add this to our backlog to complete. Otherwise, it will be closed in 7 days.'
+        stale-issue-label: 'stale'
+        stale-pr-message: "This PR has been marked stale because it has had no activity for 60 days. If you are still interested in getting this merged, please comment and we'll try to move it forward. Otherwise, it will be closed in 7 days."
+        stale-pr-label: 'stale'

data/.travis.yml

@@ -29,7 +29,8 @@ matrix:
         - docker
       rvm: 2.6.6
       env:
-        - DOCKER_COMPOSE_VERSION=1.25.5
+        - DOCKER_COMPOSE_VERSION=1.28.6
+        - DOCKER_BUILDX_VERSION=0.5.1
         # necessary to prevent overwhelming TravisCI build output limits
         - DOCKER_BUILD_FLAGS="--progress plain"
       before_install:
@@ -37,9 +38,15 @@ matrix:
         - curl --location https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname --kernel-name`-`uname --machine` > docker-compose
         - chmod +x docker-compose
         - sudo mv docker-compose /usr/local/bin
+        - mkdir -vp ~/.docker/cli-plugins
+        - curl --location https://github.com/docker/buildx/releases/download/v${DOCKER_BUILDX_VERSION}/buildx-v${DOCKER_BUILDX_VERSION}.linux-amd64 > ~/.docker/cli-plugins/docker-buildx
+        - chmod +x ~/.docker/cli-plugins/docker-buildx
+        - docker buildx create --name travis_builder --use
       script:
         - set -e
         - cd docker
         - make lint
         - make build
         - make test
+      after_script:
+        - docker buildx rm travis_builder

data/CHANGELOG.mkd

@@ -4,6 +4,38 @@ CHANGELOG
 Unreleased
 ----------
 
+3.9.3
+-----
+
+- Fixes a regression when using `--default_branch_override` with Puppetfiles containing Forge modules. [#1173](https://github.com/puppetlabs/r10k/issues/1173)
+
+3.9.2
+-----
+
+- Makes the third parameter to R10K::Actions optional, restoring backwards compatability broken in 3.9.1.
+
+3.9.1
+-----
+
+- Invalid module specifications in a Puppetfile will cause the R10K run to abort earlier than before. Prior to this release, the R10K run would complete, sync all other modules, and return an exit code of 1. R10K will now stop syncing modules and abort immediately. [#1161](https://github.com/puppetlabs/r10k/pull/1161)
+
+3.9.0
+-----
+
+- Add '--modules' flag to `deploy` subcommand as a replacement to '--puppetfile', deprecate '--puppetfile'. [#1147](https://github.com/puppetlabs/r10k/pull/1147)
+- Deprecate 'purge_whitelist' and favor usage of 'purge_allowlist'. [#1144](https://github.com/puppetlabs/r10k/pull/1144)
+- Add 'strip\_component' environment source configuration setting, to allow deploying Git branches named like "env/production" as Puppet environments named like "production". [#1128](https://github.com/puppetlabs/r10k/pull/1128)
+- A warning will be emitted when the user supplies conflicting arguments to module definitions in a Puppetfile, such as when specifying both :commit and :branch [#1130](https://github.com/puppetlabs/r10k/pull/1130)
+- Add optional standard module and environment specification interface: name, type, source, version. These options can be used when specifying environments and/or modules in a yaml/exec source, as well as when specifying modules in a Puppetfile. Providing the standard interface simplifies integrations with external services [#1131](https://github.com/puppetlabs/r10k/pull/1131)
+- Pin cri to 2.15.10 to maintain support for Ruby 2.3 and 2.4 [#1121](https://github.com/puppetlabs/r10k/issues/1121)
+
+3.8.0
+-----
+
+- When a forge module fails name validation the offending name will now be printed in the error message. [#1126](https://github.com/puppetlabs/r10k/pull/1126)
+- Module ref resolution will now fall back to the normal default branch if the default branch override cannot be resolved. [#1122](https://github.com/puppetlabs/r10k/pull/1122)
+- Experimental feature change: conflicts between environment-defined modules and Puppetfile-defined modules now default to logging a warning and deploying the environment module version, overriding the Puppetfile. Previously, conflicts would result in an error. The behavior is now configurable via the `module_conflicts` environment setting [#1107](https://github.com/puppetlabs/r10k/pull/1107)
+
 3.7.0
 -----
 

data/CODEOWNERS

@@ -1,2 +1,2 @@
-*        @puppetlabs/puppetserver-maintainers @adrienthebo @dhollinger
-/docker/ @puppetlabs/pupperware
+*        @puppetlabs/puppetserver-maintainers
+/docker/ @puppetlabs/platform-services

data/doc/common-patterns.mkd

@@ -42,3 +42,4 @@ publicly available hook. These include:
 * [Reaktor](https://github.com/pzim/reaktor)
 * [zack/r10k's Webhooks](https://forge.puppetlabs.com/zack/r10k#webhook-support)
 (Puppet Enterprise only)
+* [Simple Puppet Provisioner](https://github.com/mbaynton/SimplePuppetProvisioner)

data/doc/dynamic-environments/configuration.mkd

@@ -249,9 +249,9 @@ found which is neither committed to the control repo branch that maps to that
 environment, nor declared in a Puppetfile committed to that branch.
 
 Enabling this purge level will cause r10k to load and parse the Puppetfile for
-the environment even without the `--puppetfile` flag being set. However,
+the environment even without the `--modules` flag being set. However,
 Puppetfile content will still only be deployed if the environment is new or
-the `--puppetfile` flag is set. Additionally, no environment-level content
+the `--modules` flag is set. Additionally, no environment-level content
 will be purged if any errors are encountered while evaluating the Puppetfile
 or deploying its contents.
 
@@ -266,31 +266,31 @@ managed by a Puppetfile include the configured `moduledir` (which defaults to
 "modules") as well as alternate directories specified as an `install_path`
 option to any Puppetfile content declarations.
 
-#### purge\_whitelist
+#### purge\_allowlist
 
-The `purge_whitelist` setting exempts the specified filename patterns from
+The `purge_allowlist` setting exempts the specified filename patterns from
 being purged. This setting is currently only considered during `environment`
 level purging. (See above.) Given value must be a list of shell style filename
 patterns in string format.
 
 See the Ruby [documentation for the `fnmatch` method](http://ruby-doc.org/core-2.2.0/File.html#method-c-fnmatch)
 for more details on valid patterns. Note that the `FNM_PATHNAME` and
-`FNM_DOTMATCH` flags are in effect when r10k considers the whitelist.
+`FNM_DOTMATCH` flags are in effect when r10k considers the allowlist.
 
 Patterns are relative to the root of the environment being purged and *do
-not match recursively* by default. For example, a whitelist value of
+not match recursively* by default. For example, a allowlist value of
 `*myfile*` would only preserve a matching file at the root of the
 environment. To preserve the file throughout the deployed environment,
 a recursive pattern such as `**/*myfile*` would be required.
 
-Files matching a whitelist pattern may still be removed if they exist in
+Files matching a allowlist pattern may still be removed if they exist in
 a folder that is otherwise subject to purging. In this case, an additional
-whitelist rule to preserve the containing folder is required.
+allowlist rule to preserve the containing folder is required.
 
 ```yaml
 ---
 deploy:
-  purge_whitelist: [ 'custom.json', '**/*.xpp' ]
+  purge_allowlist: [ 'custom.json', '**/*.xpp' ]
 ```
 
 
@@ -394,6 +394,23 @@ sources:
 * if `false` (default) environment folder will not be prefixed
 * if `String` environment folder will be prefixed with the `prefix` value.
 
+### strip\_component
+
+The 'strip\_component' setting allows parts of environment names from a source to have a transformation applied, removing a part of the name before turning them into Puppet environments. This is primarily useful for VCS sources (e.g.  Git), because it allows branch names to use prefixes or organizing name components such as "env/production", "env/development", but deploy Puppet environments from these branches named without the leading "env/" component. E.g. "production", "development".
+
+```yaml
+---
+sources:
+  mysource:
+    basedir: '/etc/puppet/environments'
+    strip_component: 'env/'
+```
+
+#### strip\_component behaviour
+
+* if `string` environment names will have this prefix removed, if the prefix is present. Note that when string values are used, names can only have prefix components removed.
+* if `/regex/` the regex will be matched against environment names and if a match is found, the matching name component will be removed.
+
 ### ignore_branch_prefixes
 
 The 'ignore_branch_prefixes' setting causes environments to be ignored which match in part or whole
@@ -569,13 +586,13 @@ When using the YAML source type, every environment is enumerated in a single yam
 ---
 production:
   type: git
-  remote: git@github.com:puppetlabs/control-repo.git
-  ref: 8820892
+  source: git@github.com:puppetlabs/control-repo.git
+  version: 8820892
 
 development:
   type: git
-  remote: git@github.com:puppetlabs/control-repo.git
-  ref: 8820892
+  source: git@github.com:puppetlabs/control-repo.git
+  version: 8820892
 ```
 
 ### YAMLdir Environment Source
@@ -606,8 +623,8 @@ The contents of the file should be a hash specifying the enviornment type, and a
 # production.yaml
 ---
 type: git
-remote: git@github.com:puppetlabs/control-repo.git
-ref: 8820892
+source: git@github.com:puppetlabs/control-repo.git
+version: 8820892
 ```
 
 ### Exec environment Source
@@ -628,7 +645,7 @@ sources:
 
 The environment modules feature allows module content to be attached to an environment at environment definition time. This happens before modules specified in a Puppetfile are attached to an environment, which does not happen until deploy time. Environment module implementation depends on the environment source type.
 
-For the YAML environment source type, attach modules to an environment by specifying a modules key for the environment, and providing a hash of modules to attach. Each module accepts the same arguments accepted by the `mod` method in a Puppetfile.
+For the YAML environment source type, attach modules to an environment by specifying a modules key for the environment, and providing a hash of modules to attach. Each module accepts the same arguments accepted by the `mod` method in a Puppetfile. For ease of reading and consistency, however, it is perferred to use the generic type, source, and version options over implementation-specific formats and options such as "ref" and "git".
 
 The example below includes two Forge modules and one module sourced from a Git repository. The two environments are almost identical. However, a new version of the stdlib module has been deployed in development (6.2.0), that has not yet been deployed to production.
 
@@ -636,25 +653,35 @@ The example below includes two Forge modules and one module sourced from a Git r
 ---
 production:
   type: git
-  remote: git@github.com:puppetlabs/control-repo.git
-  ref: 8820892
+  source: git@github.com:puppetlabs/control-repo.git
+  version: 8820892
   modules:
-    puppetlabs-stdlib: 6.0.0
-    puppetlabs-concat: 6.1.0
+    puppetlabs-stdlib:
+      type: forge
+      version: 6.0.0
+    puppetlabs-concat:
+      type: forge
+      version: 6.1.0
     reidmv-xampl:
-      git: https://github.com/reidmv/reidmv-xampl.git
-      ref: 62d07f2
+      type: git
+      source: https://github.com/reidmv/reidmv-xampl.git
+      version: 62d07f2
 
 development:
   type: git
-  remote: git@github.com:puppetlabs/control-repo.git
-  ref: 8820892
+  source: git@github.com:puppetlabs/control-repo.git
+  version: 8820892
   modules:
-    puppetlabs-stdlib: 6.2.0
-    puppetlabs-concat: 6.1.0
+    puppetlabs-stdlib:
+      type: forge
+      version: 6.2.0
+    puppetlabs-concat:
+      type: forge
+      version: 6.1.0
     reidmv-xampl:
-      git: https://github.com/reidmv/reidmv-xampl.git
-      ref: 62d07f2
+      type: git
+      source: https://github.com/reidmv/reidmv-xampl.git
+      version: 62d07f2
 ```
 
 An example of a single environment definition for the YAMLdir environment source type:
@@ -663,14 +690,49 @@ An example of a single environment definition for the YAMLdir environment source
 # production.yaml
 ---
 type: git
-remote: git@github.com:puppetlabs/control-repo.git
-ref: 8820892
+source: git@github.com:puppetlabs/control-repo.git
+version: 8820892
+modules:
+  puppetlabs-stdlib:
+    type: forge
+    version: 6.0.0
+  puppetlabs-concat:
+    type: forge
+    version: 6.1.0
+  reidmv-xampl:
+    type: git
+    source: https://github.com/reidmv/reidmv-xampl.git
+    version: 62d07f2
+```
+
+#### Puppetfile module conflicts
+
+When a module is defined in an environment and also in a Puppetfile, the default behavior is for the environment definition of the module to take precedence, a warning to be logged, and the Puppetfile definition to be ignored. The behavior is configurable to optionally skip the warning, or allow a hard failure instead. Use the `module_conflicts` option in an environment definition to control this.
+
+Available `module_conflicts` options:
+
+* `override_and_warn` (default): the version of the module defined by the environment will be used, and the version defined in the Puppetfile will be ignored. A warning will be printed.
+* `override`: the version of the module defined by the environment will be used, and the version defined in the Puppetfile will be ignored.
+* `error`: an error will be raised alerting the user to the conflict. The environment will not be deployed.
+
+```yaml
+# production.yaml
+---
+type: git
+source: git@github.com:puppetlabs/control-repo.git
+version: 8820892
+module_conflicts: override_and_warn
 modules:
-  puppetlabs-stdlib: 6.0.0
-  puppetlabs-concat: 6.1.0
+  puppetlabs-stdlib:
+    type: forge
+    version: 6.0.0
+  puppetlabs-concat:
+    type: forge
+    version: 6.1.0
   reidmv-xampl:
-    git: https://github.com/reidmv/reidmv-xampl.git
-    ref: 62d07f2
+    type: git
+    source: https://github.com/reidmv/reidmv-xampl.git
+    version: 62d07f2
 ```
 
 ### Bare Environment Type
@@ -684,18 +746,28 @@ The bare environment type allows sources that support environment modules to ope
 production:
   type: bare
   modules:
-    puppetlabs-stdlib: 6.0.0
-    puppetlabs-concat: 6.1.0
+    puppetlabs-stdlib:
+      type: forge
+      version: 6.0.0
+    puppetlabs-concat:
+      type: forge
+      version: 6.1.0
     reidmv-xampl:
-      git: https://github.com/reidmv/reidmv-xampl.git
-      ref: 62d07f2
+      type: git
+      source: https://github.com/reidmv/reidmv-xampl.git
+      version: 62d07f2
 
 development:
   type: bare
   modules:
-    puppetlabs-stdlib: 6.0.0
-    puppetlabs-concat: 6.1.0
+    puppetlabs-stdlib:
+      type: forge
+      version: 6.0.0
+    puppetlabs-concat:
+      type: forge
+      version: 6.1.0
     reidmv-xampl:
-      git: https://github.com/reidmv/reidmv-xampl.git
-      ref: 62d07f2
+      type: git
+      source: https://github.com/reidmv/reidmv-xampl.git
+      version: 62d07f2
 ```

data/doc/dynamic-environments/usage.mkd

@@ -18,16 +18,16 @@ Command line invocation
 
 Recursively update all environments:
 
-    r10k deploy environment --puppetfile
+    r10k deploy environment --modules
 
 The simplest way to use r10k is by simply updating all environments and modules
 and takes the brute force approach of "update everything, ever." When this
 command is run r10k will update all sources, create new environments and delete
 old environments, and recursively update all environment modules specified in
-environment Puppetfiles. While this is the simplest method for running r10k, is
-is also the slowest by a very large degree because it does the maximum possible
-work. This should not be something you run interactively, or use on a regular
-basis.
+environment Puppetfiles, yamldirs, etc. While this is the simplest method for
+running r10k, it is also the slowest by a very large degree because it does the
+maximum possible work. This should not be something you run interactively, or
+use on a regular basis.
 
 - - -
 
@@ -55,7 +55,7 @@ only the environment itself will be updated.
 
 Update a single environment and force an update of modules:
 
-    r10k deploy environment my_working_environment --puppetfile
+    r10k deploy environment my_working_environment --modules
 
 This will update the given environment and update all contained modules. This is
 useful if you want to make sure that a given environment is fully up to date.
@@ -64,13 +64,14 @@ useful if you want to make sure that a given environment is fully up to date.
 
 Update a single environment and specify a default branch override:
 
-    r10k deploy environment my_working_environment --puppetfile --default-branch-override default_branch_override
+    r10k deploy environment my_working_environment --modules --default-branch-override default_branch_override
 
-This will update the given environment and update all contained modules, overrideing 
-the :default_branch entry in the Puppetfile of each module. This is used primarily to allow
+This will update the given environment and update all contained modules, overriding
+the :default_branch entry in the Puppetfile of each module. If the specified override branch is not
+found, it will fall back to the normal default branch and attempt to use that. This is used primarily to allow
 automated r10k solutions using the control_branch pattern with a temporary branch deployment to 
-ensure the deployment is pushed to the correct module repository branch. Note that the :default_branch
-is only ever utilized if the desired ref cannot be located.
+ensure the deployment is pushed to the correct module repository branch. Note that the :default_branch and its
+override are only ever used if the specific desired ref cannot be located.
 
 ### Deploying modules