1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Fix bundler documentation

This commit is contained in:
Toshio Kuratomi 2015-06-30 10:37:09 -07:00 committed by Matt Clay
parent ab7a8a6a11
commit a206f3d89f

View file

@ -40,18 +40,22 @@ options:
default: present default: present
chdir: chdir:
description: description:
- The directory to execute the bundler commands from. This directoy needs to contain a valid Gemfile or .bundle/ directory - The directory to execute the bundler commands from. This directoy
needs to contain a valid Gemfile or .bundle/ directory
required: false required: false
default: temporary working directory default: temporary working directory
exclude_groups: exclude_groups:
description: description:
- A list of Gemfile groups to exclude during operations. This only applies when state is C(present). Bundler considers this a 'remembered' - A list of Gemfile groups to exclude during operations. This only
property for the Gemfile and will automatically exclude groups in future operations even if C(exclude_groups) is not set applies when state is C(present). Bundler considers this
a 'remembered' property for the Gemfile and will automatically exclude
groups in future operations even if C(exclude_groups) is not set
required: false required: false
default: null default: null
clean: clean:
description: description:
- Only applies if state is C(present). If set removes any gems on the target host that are not in the gemfile - Only applies if state is C(present). If set removes any gems on the
target host that are not in the gemfile
required: false required: false
choices: [yes, no] choices: [yes, no]
default: "no" default: "no"
@ -68,8 +72,9 @@ options:
default: "no" default: "no"
deployment_mode: deployment_mode:
description: description:
- Only applies if state is C(present). If set it will only install gems that are in the default or production groups. Requires a Gemfile.lock - Only applies if state is C(present). If set it will only install gems
file to have been created prior that are in the default or production groups. Requires a Gemfile.lock
file to have been created prior
required: false required: false
choices: [yes, no] choices: [yes, no]
default: "no" default: "no"
@ -81,19 +86,25 @@ options:
default: "yes" default: "yes"
gem_path: gem_path:
description: description:
- Only applies if state is C(present). Specifies the directory to install the gems into. If C(chdir) is set then this path is relative to C(chdir) - Only applies if state is C(present). Specifies the directory to
required: false install the gems into. If C(chdir) is set then this path is relative to
default: RubyGems gem paths C(chdir)
required: false
default: RubyGems gem paths
binstub_directory: binstub_directory:
description: description:
- Only applies if state is C(present). Specifies the directory to install any gem bins files to. When executed the bin files will run within - Only applies if state is C(present). Specifies the directory to
the context of the Gemfile and fail if any required gem dependencies are not installed. If C(chdir) is set then this path is relative to C(chdir) install any gem bins files to. When executed the bin files will run
within the context of the Gemfile and fail if any required gem
dependencies are not installed. If C(chdir) is set then this path is
relative to C(chdir)
required: false required: false
default: null default: null
extra_args: extra_args:
description: description:
- A space separated string of additional commands that can be applied to the Bundler command. Refer to the Bundler documentation for more - A space separated string of additional commands that can be applied to
information the Bundler command. Refer to the Bundler documentation for more
information
required: false required: false
default: null default: null
author: Tim Hoiberg author: Tim Hoiberg