From 5d6560c6a896fa9f2d56ebba90c6d6a75806e78a Mon Sep 17 00:00:00 2001 From: Martin Alfke Date: Fri, 24 Jan 2025 19:58:28 +0100 Subject: [PATCH] Update Readme for onceover, add onceover rake tasks --- README.md | 25 +++++++++++++++++++++++++ voxbox/Rakefile | 1 + 2 files changed, 26 insertions(+) diff --git a/README.md b/README.md index 772ca7d..8463dcf 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ Too see which gems and versions are included in the container, see: ## Usage +### Rake + Change into the root of a puppet module and run the container. Make sure to mount the current directory into the container under `/repo`. The default entrypoint is rake. Without any arguments it will run `rake -T`. @@ -27,12 +29,33 @@ docker run -it --rm -v $(pwd):/repo ghcr.io/voxpupuli/voxbox:8 # rake -T docker run -it --rm -v $(pwd):/repo ghcr.io/voxpupuli/voxbox:8 spec # rake spec ``` +### Onceover + If you want to run onceover, you have to override the entrypoint: ```shell docker run -it --rm -v $(pwd):/repo --entrypoint onceover ghcr.io/voxpupuli/voxbox:8 help ``` +Onceover allows you to run tests against your control-repository. + +Running spec tests: + +```shell +docker run -it --rm -v $(pwd):/repo --entrypoint onceover ghcr.io/voxpupuli/voxbox:8 run spec +``` + +Other commands are: + +| Command | What it does | +|---|---| +| `show puppetfile` | Analyze the Puppetfile and show open updates | +| `update puppetfile` | Update modules | + +Further commands, required configuration and usage is described in the [onceover repository](https://github.com/voxpupuli/onceover). + +### Other + if you need a shell, you have to override the entrypoint: ```shell @@ -54,6 +77,8 @@ rake check:trailing_whitespace rake check_changelog # Check Changelog rake clean # Clean a built module package rake compute_dev_version # Print development version of module +rake generate_fixtures # Generate -fixtures.yml based on Puppetfile +rake generate_vendor_cache # Fetches the core modules which are usually bundled in AIO agent rake help # Display the list of available rake tasks rake lint # Run puppet-lint rake lint_fix # Run puppet-lint diff --git a/voxbox/Rakefile b/voxbox/Rakefile index db972f7..fd4d208 100644 --- a/voxbox/Rakefile +++ b/voxbox/Rakefile @@ -2,6 +2,7 @@ require 'voxpupuli/test/rake' require 'voxpupuli/acceptance/rake' require 'voxpupuli/release/rake_tasks' require 'ra10ke' +require 'onceover/rake_tasks' Ra10ke::RakeTask.new