CleanupVendor

This gem was created to help minimizing the size of your Docker images by removing the unnecessary files in the production environment.

Files like build leftovers, test files, CI configurations, etc. You can check the defaults.yml for the exact list.

Installation

Add this line to your application's Gemfile:

gem 'cleanup_vendor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cleanup_vendor

Usage

After installing all your gems in your Dockerfile with bundler, run the cleanup_vendor executable in the same RUN instruction to cut back the size of the docker image.

Something like:

RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without development test && \
  bundle exec cleanup_vendor --summary

To make it even smaller you can create a separate group in your Gemfile for this gem and remove that in the next step:

group :build do
  gem 'cleanup_vendor'
end

Then modify the previous command to something like this:

RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without development test && \
  bundle exec cleanup_vendor --summary && \
  bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without build development test && \
  bundle clean --force

If you are using multi-stage builds then you don't need to combine the commands into one RUN procedure:

RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without development test
RUN bundle exec cleanup_vendor --summary
RUN bundle install --deployment --frozen --jobs 4 --no-cache --retry 5 --without build development test
RUN bundle clean --force

Defaults

Please consult the defaults.yml file to see what files will be removed if the command executed without overrides.

Please note that patterns like **/*.rb will match every file with .rb extension recursively but a pattern like Makefile or *.txt* will be only applied if there is a gemspec file in that directory.

Overrides

The CLI supports multiple convenient options:

Usage: cleanup_vendor [options] [dir]

Specific options:
    -v, --[no-]verbose               Run verbosely
    -0, --null                       Print the pathname of the removed file to standard output, followed by an ASCII NUL character (character code 0).
        --dry-run                    Do not delete files
    -s, --summary                    Display a summary after execution
    -d, --directory PATTERN          Match on directory
    -f, --extension PATTERN          Match on file
    -e, --exclude PATTERN            Exclude pattern from matching
    -h, --help                       Show this message
    -V, --version                    Show version

Override Examples

This example excludes a file from the Password Strength gem

bundle exec cleanup_vendor --dry-run --verbose -e '**/password_strength*/*/common.txt'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/raszi/cleanup_vendor.

License

The gem is available as open source under the terms of the MIT License.