Documentation

bundler - Manage Ruby Gem dependencies with Bundler

New in version 2.0.0.

Synopsis

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

Options

parameter required default choices comments
binstub_directory
 no
    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
    		 no temporary working directory
      The directory to execute the bundler commands from. This directoy needs to contain a valid Gemfile or .bundle/ directory
      clean
      		 no no
      • True
      • False
      Only applies if state is present. If set removes any gems on the target host that are not in the gemfile
      deployment_mode
      		 no no
      • True
      • False
      Only applies if state is present. If set it will only install gems that are in the default or production groups. Requires a Gemfile.lock file to have been created prior
      exclude_groups
      		 no
        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
        		 no
          The path to the bundler executable
          extra_args
          		 no
            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
            		 no RubyGems gem paths
              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
              gemfile
              		 no Gemfile in current directory
                Only applies if state is present. The path to the gemfile to use to install gems.
                local
                		 no no
                • True
                • False
                If set only installs gems from the cache on the target host
                state
                		 no present
                • present
                • latest
                The desired state of the Gem bundle. latest updates gems to the most recent, acceptable version
                user_install
                		 no yes
                • True
                • False
                Only applies if state is present. Installs gems in the local user's cache or for all users

                Examples

                # Installs gems from a Gemfile in the current directory
- bundler: state=present executable=~/.rvm/gems/2.1.5/bin/bundle

# Excludes the production group from installing
- bundler: state=present exclude_groups=production

# Only install gems from the default and production groups
- bundler: state=present deployment=yes

# Installs gems using a Gemfile in another directory
- bundler: state=present gemfile=../rails_project/Gemfile

# Updates Gemfile in another directory
- bundler: state=latest chdir=~/rails_project

                This is an Extras Module

                For more information on what this means please read Extras Modules

                For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.