carthage_cache 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +45 -1
- data/lib/carthage_cache.rb +1 -1
- data/lib/carthage_cache/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 73f25b7f3faf2752a706604302019b44055064b6
|
|
4
|
+
data.tar.gz: 9f5f12a1ab98e03619bb977205573639d5aee282
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9461791d5b6d4e6ba87e2426fb36db02697d8288bc3b84776a2155e8a71b6550e1761cd5d9df0f891fdc69a991065cd304ac18cbfedc5d5afec7549b3776dfcf
|
|
7
|
+
data.tar.gz: a5286795ede05c4d3a694350c7420d3405cd778a5aaa2f84e7f1ee7d9ec9ba938ecc0b4ad90bc220772df30373131d00a007990686b54755df1dec4bd9ee6256
|
data/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Most libraries don't provide pre-compiled binaries, `.framework` files, in their
|
|
|
10
10
|
|
|
11
11
|
When you add slow building environments like Travis CI to the mix, a project bootstrap could take around 25 minutes just to build all your dependencies. Which is a lot for every push or pull request. You want your build and test to run really fast.
|
|
12
12
|
|
|
13
|
-
CarthageCache
|
|
13
|
+
CarthageCache generates a hash key based on the content of your `Cartfile.resolved` and checks if there is a cache archive (a zip file of your `Carthage/Build` directory) associated to that hash. If there is one it will download it and install it in your project avoiding the need to run `carthage bootstrap`.
|
|
14
14
|
|
|
15
15
|
## Installation
|
|
16
16
|
|
|
@@ -28,6 +28,28 @@ Or install it yourself as:
|
|
|
28
28
|
|
|
29
29
|
$ gem install carthage_cache
|
|
30
30
|
|
|
31
|
+
## Setup
|
|
32
|
+
|
|
33
|
+
### AWS credentials
|
|
34
|
+
|
|
35
|
+
First of all you need to configure your AWS credentials. You can do this by a `.carthage_cache.yml` file. CarthageCache will try to find this file in the current working directory. It is recommended to generate this file in each project you want to use CarthageCache.
|
|
36
|
+
|
|
37
|
+
To generate a `.carthage_cache.yml` you just need to run
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
carthage_cache config
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
You can also set your credentials using the following environmental variables
|
|
44
|
+
|
|
45
|
+
* `AWS_REGION`
|
|
46
|
+
* `AWS_ACCESS_KEY_ID`
|
|
47
|
+
* `AWS_SECRET_ACCESS_KEY`
|
|
48
|
+
|
|
49
|
+
### AWS S3 bucket
|
|
50
|
+
|
|
51
|
+
CarthageCache will assume there is a bucket named `carthage-cache`. You can change the bucket to be used by using the option `-b` or `--bucket-name`.
|
|
52
|
+
|
|
31
53
|
## Usage
|
|
32
54
|
|
|
33
55
|
If you want to bootstrap a project from cache and if there is none then fallback to Carthage.
|
|
@@ -48,6 +70,28 @@ If you want to check whether a cache exists for the current `Carfile.resolved`
|
|
|
48
70
|
carthage_cache exist
|
|
49
71
|
```
|
|
50
72
|
|
|
73
|
+
For more information run the help command
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
carthage_cache help
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Project's root directory
|
|
80
|
+
|
|
81
|
+
The `carthage_cache` command assumes that the project's root directory is the current working directory and that the `Cartfile.resolved` file is located in the project's root directory. All `carthage_cache` accept an optional argument to set the project's root directory. For example
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
carthage_cache install
|
|
85
|
+
```
|
|
86
|
+
Will try to read the `Cartfile.resolved` file from the current working directory and will install the cache archive in `./Carthage/Build`.
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
carthage_cache install PATH/TO/MY/PROJECT
|
|
90
|
+
```
|
|
91
|
+
Will try to read the `PATH/TO/MY/PROJECT/Cartfile.resolved` file from the current working directory and will install the cache archive in `PATH/TO/MY/PROJECT/Carthage/Build`.
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
51
95
|
## Development
|
|
52
96
|
|
|
53
97
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
data/lib/carthage_cache.rb
CHANGED