vagrant-box-s3 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +35 -5
- data/lib/vagrant-box-s3/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6c6adbd29229bd4e574f4acb7db8a2ede3d4098bf5759bc4564df93714fc4ba3
|
4
|
+
data.tar.gz: 89349385e4700a9bf7c66a8ed8d597e460d65a33bfea8ffb57d071dead0c2727
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6ab64f9ce45890a1ee48a96a13290c334778b4ed16a49dff359afbdba26990a85d328f085d574093fe4b6f8c2ecc449ffc28d39f68f9d5c57d5e1e841c7cafba
|
7
|
+
data.tar.gz: 625bbb320c28455d9be19a316f63103a96726d4942f7ccab62d5b7cfd9a4b4ab50fcac96df9a5356f2bd4449d9adc15f3543e4b6d607cd8f9b096ec35aa31cde
|
data/README.md
CHANGED
@@ -14,11 +14,20 @@ override the `execute_curl` method to replace S3 box URLs with pre-signed S3 URL
|
|
14
14
|
|
15
15
|
## Installation
|
16
16
|
|
17
|
-
|
17
|
+
Via Vagrantfile, using [config.vagrant.plugins](https://developer.hashicorp.com/vagrant/docs/vagrantfile/vagrant_settings#config-vagrant-plugins):
|
18
|
+
|
19
|
+
Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
|
20
|
+
config.vagrant.plugins = ['vagrant-box-s3', 'other-plugin']
|
21
|
+
...
|
22
|
+
end
|
23
|
+
|
24
|
+
Or via plugin install command:
|
25
|
+
|
26
|
+
vagrant plugin install vagrant-box-s3
|
18
27
|
|
19
28
|
## Usage
|
20
29
|
|
21
|
-
The plugin
|
30
|
+
The plugin will automatically sign requests to AWS S3 URLs with your AWS credentials, allowing storage of private
|
22
31
|
boxes on S3 with your own bucket policies in place.
|
23
32
|
|
24
33
|
## Configuration
|
@@ -100,23 +109,44 @@ A specific version of ruby can be installed on macOS via rbenv:
|
|
100
109
|
|
101
110
|
ruby -v
|
102
111
|
|
112
|
+
|
113
|
+
### Builds
|
114
|
+
|
103
115
|
If bundled packages / dependencies have changed, run bundle install:
|
104
116
|
|
105
117
|
bundle install --path vendor/bundle
|
106
118
|
|
107
|
-
To build the plugin, use `rake build`, this will create a file with the current version number, e.g. `pkg/vagrant-box-s3-0.1.2.gem`.
|
108
|
-
|
109
119
|
Update the current version in `lib/vagrant-box-s3/version.rb`.
|
110
120
|
|
121
|
+
### Dev build and test
|
122
|
+
|
123
|
+
To build the plugin, use `rake build`, this will create a file with the current version number, e.g. `pkg/vagrant-box-s3-0.1.2.gem`.
|
124
|
+
|
111
125
|
Testing the plugin requires installing into vagrant from the build:
|
112
126
|
|
113
127
|
vagrant plugin install ../vagrant-box-s3/pkg/vagrant-box-s3-0.1.2.gem
|
114
128
|
|
115
129
|
Then running a command that will trigger box URL related actions, such as `vagrant up`, `vagrant box update` etc. with the `--debug` flag.
|
116
130
|
|
131
|
+
### Releases
|
132
|
+
|
133
|
+
To release a new version to [RubyGems.org](https://rubygems.org/gems/vagrant-box-s3), you must be authenticated.
|
134
|
+
|
135
|
+
If you have not previously authenticated, sign in:
|
136
|
+
|
137
|
+
gem signin
|
138
|
+
|
139
|
+
This will store and use credentials in `~/.gem/credentials`.
|
140
|
+
|
141
|
+
Ensure the new version number is correctly set in `lib/vagrant-box-s3/version.rb`.
|
142
|
+
|
143
|
+
Then you can build and push the release:
|
144
|
+
|
145
|
+
rake release
|
146
|
+
|
117
147
|
## Contributing
|
118
148
|
|
119
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
149
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/memiah/vagrant-box-s3.
|
120
150
|
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
121
151
|
|
122
152
|
## License
|