community.general.bundler – Manage Ruby Gem dependencies with Bundler

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.bundler.

Synopsis

Manage installation and Gem version dependencies for Ruby using the Bundler gem

Parameters

Parameter	Choices/Defaults	Comments
binstub_directory path		Only applies if state is `present`. Specifies the directory to 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 `chdir` is set then this path is relative to `chdir`
chdir path		The directory to execute the bundler commands from. This directory needs to contain a valid Gemfile or .bundle/ directory If not specified, it will default to the temporary working directory
clean boolean	Choices: no ← yes	Only applies if state is `present`. If set removes any gems on the target host that are not in the gemfile
deployment_mode boolean	Choices: no ← yes	Only applies if state is `present`. If set it will install gems in ./vendor/bundle instead of the default location. Requires a Gemfile.lock file to have been created prior
exclude_groups list / elements=string		A list of Gemfile groups to exclude during operations. This only applies when state is `present`. Bundler considers this a 'remembered' property for the Gemfile and will automatically exclude groups in future operations even if `exclude_groups` is not set
executable string		The path to the bundler executable
extra_args string		A space separated string of additional commands that can be applied to the Bundler command. Refer to the Bundler documentation for more information
gem_path path		Only applies if state is `present`. Specifies the directory to install the gems into. If `chdir` is set then this path is relative to `chdir` If not specified the default RubyGems gem paths will be used.
gemfile path		Only applies if state is `present`. The path to the gemfile to use to install gems. If not specified it will default to the Gemfile in current directory
local boolean	Choices: no ← yes	If set only installs gems from the cache on the target host
state string	Choices: present ← latest	The desired state of the Gem bundle. `latest` updates gems to the most recent, acceptable version
user_install boolean	Choices: no yes ←	Only applies if state is `present`. Installs gems in the local user's cache or for all users

Examples

- name: Install gems from a Gemfile in the current directory
  community.general.bundler:
    state: present
    executable: ~/.rvm/gems/2.1.5/bin/bundle

- name: Exclude the production group from installing
  community.general.bundler:
    state: present
    exclude_groups: production

- name: Install gems into ./vendor/bundle
  community.general.bundler:
    state: present
    deployment_mode: yes

- name: Install gems using a Gemfile in another directory
  community.general.bundler:
    state: present
    gemfile: ../rails_project/Gemfile

- name: Update Gemfile in another directory
  community.general.bundler:
    state: latest
    chdir: ~/rails_project

Authors

Tim Hoiberg (@thoiberg)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/bundler_module.html

Docs

Docs4dev

Title here