2018-11-02 19:07:56 -04:00
|
|
|
BUNDLE-PACKAGE(1) BUNDLE-PACKAGE(1)
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
NAME
|
|
|
|
bundle-package - Package your needed .gem files into your application
|
2018-11-02 19:07:56 -04:00
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
SYNOPSIS
|
|
|
|
bundle package
|
2018-11-02 19:07:56 -04:00
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
DESCRIPTION
|
|
|
|
Copy all of the .gem files needed to run the application into the ven-
|
|
|
|
dor/cache directory. In the future, when running [bundle
|
|
|
|
install(1)][bundle-install], use the gems in the cache in preference to
|
|
|
|
the ones on rubygems.org.
|
2018-11-02 19:07:56 -04:00
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
GIT AND PATH GEMS
|
|
|
|
Since Bundler 1.2, the bundle package command can also package :git and
|
|
|
|
:path dependencies besides .gem files. This needs to be explicitly
|
|
|
|
enabled via the --all option. Once used, the --all option will be
|
|
|
|
remembered.
|
2018-11-02 19:07:56 -04:00
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
SUPPORT FOR MULTIPLE PLATFORMS
|
2018-11-02 19:07:56 -04:00
|
|
|
When using gems that have different packages for different platforms,
|
|
|
|
Bundler 1.8 and newer support caching of gems for other platforms where
|
2019-04-14 02:01:35 -04:00
|
|
|
the Gemfile has been resolved (i.e. present in the lockfile) in ven-
|
|
|
|
dor/cache. This needs to be enabled via the --all-platforms option.
|
2018-11-02 19:07:56 -04:00
|
|
|
This setting will be remembered in your local bundler configuration.
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
REMOTE FETCHING
|
|
|
|
By default, if you run bundle install(1)](bundle-install.1.html) after
|
|
|
|
running bundle package(1) bundle-package.1.html, bundler will still
|
|
|
|
connect to rubygems.org to check whether a platform-specific gem exists
|
|
|
|
for any of the gems in vendor/cache.
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
For instance, consider this Gemfile(5):
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
source "https://rubygems.org"
|
|
|
|
|
|
|
|
gem "nokogiri"
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
If you run bundle package under C Ruby, bundler will retrieve the ver-
|
|
|
|
sion of nokogiri for the "ruby" platform. If you deploy to JRuby and
|
|
|
|
run bundle install, bundler is forced to check to see whether a "java"
|
|
|
|
platformed nokogiri exists.
|
2018-11-02 19:07:56 -04:00
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
Even though the nokogiri gem for the Ruby platform is technically
|
|
|
|
acceptable on JRuby, it has a C extension that does not run on JRuby.
|
|
|
|
As a result, bundler will, by default, still connect to rubygems.org to
|
2018-11-02 19:07:56 -04:00
|
|
|
check whether it has a version of one of your gems more specific to
|
|
|
|
your platform.
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
This problem is also not limited to the "java" platform. A similar
|
2018-11-02 19:07:56 -04:00
|
|
|
(common) problem can happen when developing on Windows and deploying to
|
|
|
|
Linux, or even when developing on OSX and deploying to Linux.
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
If you know for sure that the gems packaged in vendor/cache are appro-
|
|
|
|
priate for the platform you are on, you can run bundle install --local
|
|
|
|
to skip checking for more appropriate gems, and use the ones in ven-
|
|
|
|
dor/cache.
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
One way to be sure that you have the right platformed versions of all
|
2019-04-14 02:01:35 -04:00
|
|
|
your gems is to run bundle package on an identical machine and check in
|
|
|
|
the gems. For instance, you can run bundle package on an identical
|
|
|
|
staging box during your staging process, and check in the vendor/cache
|
2018-11-02 19:07:56 -04:00
|
|
|
before deploying to production.
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
By default, bundle package(1) bundle-package.1.html fetches and also
|
2018-11-02 19:07:56 -04:00
|
|
|
installs the gems to the default location. To package the dependencies
|
2019-04-14 02:01:35 -04:00
|
|
|
to vendor/cache without installing them to the local install location,
|
|
|
|
you can run bundle package --no-install.
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
2019-07-10 11:26:55 -04:00
|
|
|
August 2019 BUNDLE-PACKAGE(1)
|