Skip to content

Commit b93cb79

Browse files
committed
add README section
1 parent 3158678 commit b93cb79

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,56 @@ podman run -it --rm -v $PWD:/repo:Z --entrypoint rubocop ghcr.io/voxpupuli/voxbo
320320
podman run -it --rm -v $PWD:/repo:Z --entrypoint rubocop ghcr.io/voxpupuli/voxbox:8 --auto-gen-config
321321
```
322322

323+
## EasyVoxBox (evb)
324+
The [evb script](evb) shortens the commands to be typed for running voxbox. Additionaly, it does not care about the sequence of
325+
options, wich can be usefull for setting shell aliases. To run the command you must change into any subdirectory of a openvox module
326+
(with a metadata.json file) or a control repository (with a Puppetfile).
327+
328+
Display the evb help message:
329+
```shell
330+
$ evb help
331+
Usage: /usr/local/bin/evb [options] [command]
332+
333+
available options:
334+
--noop : print the command to run, but do not run it
335+
--entrypoint : use a different entrypoint
336+
examples for available endpoints are:
337+
onceover, ash, puppet, yamllint, jq, curl, rubocop
338+
default: no entrypoint specified
339+
--image image : use a different image (default ghcr.io/voxpupuli/voxbox:8)
340+
--env VAR=val : specify environment variables (can be used multiple times)
341+
Remark: the term './' in a assignment will be replaced with
342+
the correct path to be used in the container.
343+
Example: if you start the script in ~/openvox-supermodule/spec/classes
344+
and set --env SPEC=./supermodule_spec.rb we will
345+
run VoxBox with -e SPEC=spec/classes/supermodule_spec.rb
346+
--volume vol : specify an additional volume to put into the container
347+
see podman man page how to specify 'vol'. (no path magic is done ;))
348+
--runcmd : this lets you change the program used to start the container
349+
if not set explicit it looks for podman or docker.
350+
351+
available command:
352+
help : print this help message and exit
353+
354+
commands/options not listed here are passed to VoxBox as is.
355+
use the '--noop' option to print the detailed call to VoxBox.
356+
```
357+
358+
See the command that would be executed (dropping the --noop option will run the command):
359+
```shell
360+
evb --noop # for rake -T
361+
evb --noop spec # for rake spec
362+
evb --noop --env SPEC=./example_spec.rb spec # for only a specific spec in the current subdirectory
363+
evb --noop --entrypoint onceover --help # onceover help
364+
365+
# or the release rake task
366+
evb --volume ~/.gitconfig:/etc/gitconfig:ro \
367+
--volume ~/.ssh:/root/.ssh \
368+
--volume ${SSH_AUTH_SOCK}:${SSH_AUTH_SOCK} \
369+
--env SSH_AUTH_SOCK="${SSH_AUTH_SOCK}" \
370+
release --noop
371+
```
372+
323373
## GitLab
324374
325375
### Example GitLab CI configuration

evb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ available options:
2222
--noop : print the command to run, but do not run it
2323
--entrypoint : use a different entrypoint
2424
examples for available endpoints are:
25-
onceover,
25+
onceover, ash, puppet, yamllint, jq, curl, rubocop
2626
default: no entrypoint specified
2727
--image image : use a different image (default ${PODIMAGE})
2828
--env VAR=val : specify environment variables (can be used multiple times)

0 commit comments

Comments
 (0)