vagrant-box-s3 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d81dbf3d8b32768cfc022e376cfc5426bf6f84048e51788244ec03bf092cc827
-  data.tar.gz: 7d4edce6804ea7df82cbc6dd4faf781b486e8eec61979e595b45a321a000bf27
+  metadata.gz: 6c6adbd29229bd4e574f4acb7db8a2ede3d4098bf5759bc4564df93714fc4ba3
+  data.tar.gz: 89349385e4700a9bf7c66a8ed8d597e460d65a33bfea8ffb57d071dead0c2727
 SHA512:
-  metadata.gz: 22d63d9785c64664cdd552f4486870711caa7f6141a11756505d92c44ff7a140922fe7158708a2992e03cbfaade073a9782de46296b4462eedcf977d193439bb
-  data.tar.gz: bac015704c14167f29339d1390cd4458c732d945d02075201024f50ad5e72d0a2196a115ae8f1975b0c0ef6df0e13b8348f30a372754804089aff0f4e2e433b5
+  metadata.gz: 6ab64f9ce45890a1ee48a96a13290c334778b4ed16a49dff359afbdba26990a85d328f085d574093fe4b6f8c2ecc449ffc28d39f68f9d5c57d5e1e841c7cafba
+  data.tar.gz: 625bbb320c28455d9be19a316f63103a96726d4942f7ccab62d5b7cfd9a4b4ab50fcac96df9a5356f2bd4449d9adc15f3543e4b6d607cd8f9b096ec35aa31cde

data/README.md

@@ -14,11 +14,20 @@ override the `execute_curl` method to replace S3 box URLs with pre-signed S3 URL
 
 ## Installation
 
-    vagrant plugin install ../vagrant-box-s3/pkg/vagrant-box-s3-0.1.2.gem
+Via Vagrantfile, using [config.vagrant.plugins](https://developer.hashicorp.com/vagrant/docs/vagrantfile/vagrant_settings#config-vagrant-plugins): 
+
+    Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+      config.vagrant.plugins = ['vagrant-box-s3', 'other-plugin']
+      ...
+    end
+
+Or via plugin install command:
+
+    vagrant plugin install vagrant-box-s3
 
 ## Usage
 
-The plugin with automatically sign requests to AWS S3 URLs with your AWS credentials, allowing you to store private
+The plugin will automatically sign requests to AWS S3 URLs with your AWS credentials, allowing storage of private
 boxes on S3 with your own bucket policies in place.
 
 ## Configuration
@@ -100,23 +109,44 @@ A specific version of ruby can be installed on macOS via rbenv:
 
     ruby -v
 
+
+### Builds
+
 If bundled packages / dependencies have changed, run bundle install:
 
     bundle install --path vendor/bundle
 
-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`.
-
 Update the current version in `lib/vagrant-box-s3/version.rb`.
 
+### Dev build and test
+
+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`.
+
 Testing the plugin requires installing into vagrant from the build:
 
     vagrant plugin install ../vagrant-box-s3/pkg/vagrant-box-s3-0.1.2.gem
 
 Then running a command that will trigger box URL related actions, such as `vagrant up`, `vagrant box update` etc. with the `--debug` flag.
 
+### Releases
+
+To release a new version to [RubyGems.org](https://rubygems.org/gems/vagrant-box-s3), you must be authenticated.
+
+If you have not previously authenticated, sign in:
+
+    gem signin
+
+This will store and use credentials in `~/.gem/credentials`.
+
+Ensure the new version number is correctly set in `lib/vagrant-box-s3/version.rb`.
+
+Then you can build and push the release:
+
+    rake release
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vagrant-box-s3. 
+Bug reports and pull requests are welcome on GitHub at https://github.com/memiah/vagrant-box-s3. 
 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.
 
 ## License

data/lib/vagrant-box-s3/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module BoxS3
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-box-s3
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steve Whiteley