From 880590ea768eed1f2d88609518b9c0cf4580cdc0 Mon Sep 17 00:00:00 2001 From: Eric Putnam Date: Thu, 3 Jul 2025 14:31:34 -0700 Subject: [PATCH] (maint) Update README for puppet 8 updates The puppet-dev-tools Gemfile received a bunch of updates on this, the puppet8 branch. As such, the list of available Rake tasks in the image has changed. This change includes the README updates from running update_readme.sh in the new gem environment. --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 87638bd..283352b 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,12 @@ docker run --rm -v $(pwd):/repo puppet/puppet-dev-tools:puppet8 \ | Command | Description | | ------- | ----------- | -| rake beaker | Run beaker acceptance tests | -| rake beaker:sets | List available beaker nodesets | -| rake beaker:ssh[set,node] | Try to use vagrant to login to the Beaker node | -| rake build | Build puppet module package | -| rake build:pdk | Build Puppet module with PDK | -| rake build:pmt | Build Puppet module package with PMT (Puppet < 6.0.0 only) | | rake check | Run static pre release checks | | rake check:dot_underscore | Fails if any ._ files are present in directory | | rake check:git_ignore | Fails if directories contain the files specified in .gitignore | | rake check:symlinks | Fails if symlinks are present in directory | | rake check:test_file | Fails if .pp files present in tests folder | | rake check_for_spec_tests | Get spec test status | -| rake clean | Clean a built module package | | rake compute_dev_version | Print development version of module | | rake generate_fixtures | Writes a `fixtures.yml` file based on the Puppetfile / Generate Fixtures files for role/profile | | rake generate_spec_tests | Generate spec tests for missing classes | @@ -68,14 +61,18 @@ docker run --rm -v $(pwd):/repo puppet/puppet-dev-tools:puppet8 \ | rake parallel_spec_standalone | Parallel spec tests | | rake pe_only_mods | Show PE Only Modules | | rake r10k:dependencies | Print outdated forge modules | +| rake r10k:deprecation | Validate that no forge modules are deprecated | +| rake r10k:diff[branch_a,branch_b] | Check for module differences between two branches of a Puppetfile | | rake r10k:duplicates | Check Puppetfile for duplicates | | rake r10k:install | Install modules specified in Puppetfile | +| rake r10k:print_git_conversion | Convert and print forge modules to git format | | rake r10k:solve_dependencies[allow_major_bump] | Find missing or outdated module dependencies | | rake r10k:syntax | Syntax check Puppetfile | | rake r10k:validate | Validate the git urls and branches, refs, or tags | | rake release_checks | Runs all necessary checks on a module in preparation for a release | | rake rubocop | Run RuboCop | -| rake rubocop:auto_correct | Auto-correct RuboCop offenses | +| rake rubocop:autocorrect | Autocorrect RuboCop offenses (only when it's safe) | +| rake rubocop:autocorrect_all | Autocorrect RuboCop offenses (safe and unsafe) | | rake run_tests | Run tests | | rake spec | Run spec tests and clean the fixtures directory if successful | | rake spec:simplecov | Run spec tests with ruby simplecov code coverage | @@ -87,7 +84,8 @@ docker run --rm -v $(pwd):/repo puppet/puppet-dev-tools:puppet8 \ | rake strings:generate[patterns,debug,backtrace,markup,json,markdown,yard_args] | Generate Puppet documentation with YARD | | rake strings:generate:reference[patterns,debug,backtrace] | Generate Puppet Reference documentation | | rake strings:gh_pages:update | Update docs on the gh-pages branch and push to GitHub | -| rake syntax | Syntax check Puppet manifests and templates | +| rake strings:validate:reference[patterns,debug,backtrace] | Validate the reference is up to date | +| rake syntax | Syntax check for Puppet manifests, templates and Hiera | | rake syntax:hiera | Syntax check Hiera config files | | rake syntax:manifests | Syntax check Puppet manifests | | rake syntax:templates | Syntax check Puppet templates |