summaryrefslogtreecommitdiff
path: root/vendor/gems/bundler-checksum/README.md
blob: 1420dc49b94088e85de666b99b21a7023fe871d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# bundler-checksum

Bundler patch for verifying local gem checksums

## Install

Add the following to your Gemfile:

```
if ENV['BUNDLER_CHECKSUM_VERIFICATION_OPT_IN'] # this verification is still experimental
  require 'bundler-checksum'
  Bundler::Checksum.patch!
end
```

## Usage

Once the gem is installed, bundler-checksum will verify gems before
installation.

If a new or updated gem is to be installed, the remote checksum of that gem is stored in `Gemfile.checksum`.
Checksum entries for other versions of the gem are removed from `Gemfile.checksum`.

If a version of a gem is to be installed that is already present in `Gemfile.checksum`, the remote and local
checksums are compared and an error is prompted if they do not match.

Gem checksums for all platforms are stored in `Gemfile.checksum`.
When `bundler-checksum` runs it will only verify the checksum for the platform that `bundle` wants to download.


## Development