stack_master-gpg_parameter_resolver 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fc4db57d3a112d968723bf5428f05f35ef3acbc696aad4ab3c9fd0ed9ed6a99
-  data.tar.gz: 838b08e44cff48597a5d16b18fc6ac5731ae142de3bfd716f874e7ebf1505cba
+  metadata.gz: 7f91d2cae12ba799303b174895b1ec5a67a478ae0b7192b353cf2247d419c99f
+  data.tar.gz: 91e1bca8144ba9c16c1fe53667e8dd6d1b8e194663e92fcd8eae82b453153674
 SHA512:
-  metadata.gz: 07f30ed16fccaa665dc1f12d769a1542bad0a5e34d88fa3695ab515069508bb1c2f222f85d18e025bfe0487b731afba04c9d7c91763bdda8142c7f37a3991477
-  data.tar.gz: 16bc5f43aea1d7efeb6a15a1b26f18f21b30ff3a10a4f583a5c78c5a1064bf9eb7dc26769b79ab6622dc7fdb4662e1688a9f2e9e175fe555cf8e4545f103514d
+  metadata.gz: 2e7f87c34e76d32b7d4183a56b1710719ebc9cee88050a748aaa88de4ff1d54d65eb87fc0b5ba7ab989352e423853c523617a16de8086d0de7c4c01c999e54b7
+  data.tar.gz: 3b129636d74fc318f926427c24c70a0f6fd7eeaa15393829878adc5829a31f6a826601296a5e61e270997e3d776c2517b3b334a2260e0fb49c33427d4e1af6cf

data/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+[Unreleased]: https://github.com/envato/stack_master-gpg_parameter_resolver/compare/v1.0.0...HEAD
+
+## [1.0.0] - 2020-03-04
+
+### Added
+
+- Usage documentation added to the readme ([#1]).
+
+### Changed
+
+- Require `stack_master` version 2 or above ([#2]).
+- Remove version restrictions on `rake` ([#3]).
+
+[1.0.0]: https://github.com/envato/stack_master-gpg_parameter_resolver/compare/v0.1.0...v1.0.0
+[#1]: https://github.com/envato/stack_master-gpg_parameter_resolver/pull/1
+[#2]: https://github.com/envato/stack_master-gpg_parameter_resolver/pull/2
+[#3]: https://github.com/envato/stack_master-gpg_parameter_resolver/pull/3
+
+## [0.1.0] - 2019-07-19
 ### Added
 
 - Functionality extracted from the StackMaster gem.
+
+[0.1.0]: https://github.com/envato/stack_master-gpg_parameter_resolver/tree/v0.1.0

data/README.md

@@ -2,9 +2,9 @@
 
 [![Build Status](https://travis-ci.org/envato/stack_master-gpg_parameter_resolver.svg?branch=master)](https://travis-ci.org/envato/stack_master-gpg_parameter_resolver)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stack_master/gpg_parameter_resolver`. To experiment with that code, run `bin/console` for an interactive prompt.
+Resolve [StackMaster] parameters from within GPG encrypted YAML files.
 
-TODO: Delete this and the text above, and describe your gem
+[StackMaster]: https://github.com/envato/stack_master
 
 ## Installation
 
@@ -24,7 +24,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The secret parameters resolver expects a `secret_file` to be defined in the
+stack definition which is a GPG encrypted YAML file. Once decrypted and parsed,
+the value provided to the secret resolver is used to lookup the associated key
+in the secret file. A common use case for this is to store database passwords.
+
+stack_master.yml:
+
+```yaml
+stacks:
+  us-east-1:
+    my_app:
+      template: my_app.json
+      secret_file: production.yml.gpg
+```
+
+secrets/production.yml.gpg, when decrypted:
+
+```yaml
+db_password: my-password
+```
+
+parameters/my_app.yml:
+
+```yaml
+db_password:
+  secret: db_password
+```
 
 ## Development
 

data/lib/stack_master/gpg_parameter_resolver/version.rb

@@ -1,5 +1,5 @@
 module StackMaster
   module GpgParameterResolver
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master-gpg_parameter_resolver
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stack_master
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: dotgpg
   requirement: !ruby/object:Gem::Requirement
@@ -57,16 +57,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +101,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/envato/stack_master-gpg_parameter_resolver
   source_code_uri: https://github.com/envato/stack_master-gpg_parameter_resolver
-  changelog_uri: https://github.com/envato/stack_master-gpg_parameter_resolver/blob/v0.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/envato/stack_master-gpg_parameter_resolver/blob/v1.0.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/envato/stack_master-gpg_parameter_resolver/issues
 post_install_message: 
 rdoc_options: []
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Allow parameters to be stored in encrypted secret files, protected with GPG