ruby-terraform 1.6.0.pre.2 → 1.6.0.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79453b452518ccf2c617a52e8c3d656002a5badcab65ff43b695896efb14a3b7
-  data.tar.gz: aa197b7fcd9d7b70b9994591b2a40df912bd22ab0637a804d79c0ed820d11b60
+  metadata.gz: b3d7192a520d734b246ea0384e49ac60341ed2169ddad8dd63bd0f8c281b5715
+  data.tar.gz: 5ca820f3ee95ce07d2d8d5f1e13edf284e53eabd7137732d20234eee4b3f30d7
 SHA512:
-  metadata.gz: f0597645da564079c828ff12a32ddd41324abd8c52086ef83e8fb78d8726ed97fbbca857b4f0355cf48a493dabfea6ab06ccb23849e4123ca7aa8ad1b767bedd
-  data.tar.gz: 668bdeb6b8d8d873f2b7c44314081befcb66e1abee7cf45fdf4a4099d2a7fa30c58d051ee3b1f307a6a1d20648bbcf2df820ff14345251b853eb10b454f844e1
+  metadata.gz: 565db2201a431fa3b53e75162c965717fb6b76f935404f75f521ae374c44bc651e7c5c428a2ac6b87993df5a2668922a7b17d55069194e00ec52aba2bb520cf6
+  data.tar.gz: efc862a5c9a2385a7f28f53d71baa6a6b4aa7bc50ae7bbfe7e5de289af95ccb9d8966d4636176c5ecfbcefcd46c75feb0eb4e9b2056a2979abbcf0a0459ba806

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (1.6.0.pre.2)
+    ruby-terraform (1.6.0.pre.5)
       immutable-struct (~> 2.4)
       lino (~> 3.0)
 
@@ -50,6 +50,7 @@ GEM
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     immutable-struct (2.4.1)
+    json (2.6.2)
     lino (3.0.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
@@ -114,7 +115,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.31.0)
+    rubocop (1.31.1)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/README.md

@@ -3,7 +3,6 @@
 A simple wrapper around the Terraform binary to allow execution from within
 a Ruby program, RSpec test or Rakefile.
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +19,6 @@ Or install it yourself as:
 
     $ gem install ruby-terraform
 
-
 ## Usage
 
 To require `RubyTerraform`:
@@ -82,6 +80,30 @@ RubyTerraform.destroy(
 )
 ```
 
+Each class method also accepts a second hash argument of invocation options to
+use at command invocation time. Currently, the only supported option is
+`:environment` which allows environment variables to be exposed to Terraform.
+
+For example, to apply a configuration with trace level logging:
+
+```ruby
+RubyTerraform.apply(
+  {
+    chdir: 'infra/network',
+    plan: 'network.tfplan',
+    vars: {
+      region: 'eu-central'
+    },
+    var_file: 'defaults.tfvars'
+  },
+  {
+    environment: {
+      'TF_LOG' => 'trace'
+    }
+  }
+)
+```
+
 Additionally, `RubyTerraform` allows command instances to be constructed and
 invoked separately. This is useful when you need to override global
 configuration on a command by command basis or when you need to pass a command
@@ -102,28 +124,31 @@ command.execute(
 )
 ```
 
+As with the class methods, the `#execute` method accepts a second hash argument
+of invocation options allowing an environment to be specified.
+
 See the [API docs](https://infrablocks.github.io/ruby_terraform/index.html) for
-the 
+the
 [`RubyTerraform` module](https://infrablocks.github.io/ruby_terraform/RubyTerraform.html)
-or the 
+or the
 [`RubyTerraform::Commands` module](https://infrablocks.github.io/ruby_terraform/RubyTerraform/Commands.html)
 more details on the supported commands.
 
 ### Parameters
 
 The parameter hash passed to each command, whether via the class methods or the
-`#execute` method, supports all the options available on the corresponding 
+`#execute` method, supports all the options available on the corresponding
 Terraform command. There are a few different types of options depending on what
 Terraform expects to receive:
 
 * `Boolean` options, accepting `true` or `false`, such as `:input` or `:lock`;
-* `String` options, accepting a single string value, such as `:state` or 
+* `String` options, accepting a single string value, such as `:state` or
   `:target`;
 * `Array<String>` options, accepting an array of strings, such as `:var_files`
   or `:targets`; and
 * `Hash<String,Object>` options, accepting a hash of key value pairs, where the
   value might be complex, such as `:vars` and `:backend_config`.
-  
+
 For all options that allow multiple values, both a singular and a plural option
 key are supported. For example, to specify multiple var files during a plan:
 
@@ -211,6 +236,7 @@ RubyTerraform.configure do |config|
   config.stderr = multi_io
 end
 ```
+
 > Creating the Logger with a file this way (using `Logger::LogDevice`),
 > guarantees that the buffer content will be saved/written, as it sets
 > **implicit flushing**.
@@ -218,7 +244,7 @@ end
 Configured in this way, any logging performed by `RubyTerraform` will log to
 both `STDOUT` and to the specified file.
 
-To configure the logger on a command by command basis, for example for the 
+To configure the logger on a command by command basis, for example for the
 `Show` command:
 
 ```ruby
@@ -298,7 +324,7 @@ To install dependencies and run the build, run the pre-commit build:
 ./go
 ```
 
-This runs all unit tests and other checks including coverage and code linting / 
+This runs all unit tests and other checks including coverage and code linting /
 formatting.
 
 To run only the unit tests, including coverage:
@@ -319,7 +345,7 @@ To check for code linting / formatting issues without fixing:
 ./go library:check
 ```
 
-You can also run `bin/console` for an interactive prompt that will allow you to 
+You can also run `bin/console` for an interactive prompt that will allow you to
 experiment.
 
 ### Managing CircleCI keys
@@ -352,7 +378,6 @@ https://github.com/infrablocks/ruby_terraform. 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
 
 The gem is available as open source under the terms of the

data/Rakefile

@@ -58,7 +58,7 @@ namespace :library do
   task check: [:rubocop]
 
   desc 'Attempt to automatically fix issues with the library'
-  task fix: [:'rubocop:auto_correct']
+  task fix: [:'rubocop:autocorrect']
 end
 
 namespace :documentation do

data/lib/ruby_terraform/commands/apply.rb

@@ -71,6 +71,11 @@ module RubyTerraform
     #   +:var_file+ and +:var_files+ are provided, all var files will be passed
     #   to terraform.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Apply.new.execute(
     #     directory: 'infra/networking',

data/lib/ruby_terraform/commands/base.rb

@@ -27,6 +27,10 @@ module RubyTerraform
       # @param [Hash<String, Object>] parameters The parameters used to
       #   invoke the command. See subclass documentation for details of
       #   supported options.
+      # @param [Hash<String, Object>] invocation_options Additional options
+      #   controlling the invocation of the command.
+      # @option invocation_options [Hash<String, String>] :environment A map
+      #   of environment variables to expose at command invocation time.
       def execute(parameters = {}, invocation_options = {})
         do_before(parameters)
         build_and_execute_command(parameters, invocation_options)

data/lib/ruby_terraform/commands/destroy.rb

@@ -56,6 +56,11 @@ module RubyTerraform
     #   +:var_file+ and +:var_files+ are provided, all var files will be passed
     #   to terraform.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Destroy.new.execute(
     #     directory: 'infra/networking',

data/lib/ruby_terraform/commands/force_unlock.rb

@@ -28,6 +28,11 @@ module RubyTerraform
     # * +:force+: If +true+, does not ask for input for unlock confirmation;
     #   defaults to +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::ForceUnlock.new.execute(
     #     lock_id: '50e844a7-ebb0-fcfd-da85-5cce5bd1ec90')

data/lib/ruby_terraform/commands/format.rb

@@ -41,6 +41,11 @@ module RubyTerraform
     #   defaults to +false+ such that only the provided +:directory+ is
     #   processed.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Format.new.execute(
     #     directory: 'infra/networking')

data/lib/ruby_terraform/commands/get.rb

@@ -31,6 +31,11 @@ module RubyTerraform
     # * +:no_color+: whether or not the output from the command should be in
     #   color; defaults to +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Get.new.execute(
     #     directory: 'infra/networking')

data/lib/ruby_terraform/commands/graph.rb

@@ -40,6 +40,11 @@ module RubyTerraform
     # * +:module_depth+: (deprecated) in prior versions of terraform, specified
     #   the depth of modules to show in the output.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Graph.new.execute
     #

data/lib/ruby_terraform/commands/import.rb

@@ -81,6 +81,11 @@ module RubyTerraform
     #   Cloud workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Import.new.execute(
     #     directory: 'infra/networking',

data/lib/ruby_terraform/commands/init.rb

@@ -72,6 +72,11 @@ module RubyTerraform
     # * +:lockfile+: sets a dependency lockfile mode; currently only "readonly"
     #   is valid.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Init.new.execute(
     #     from_module: 'some/module/path',

data/lib/ruby_terraform/commands/login.rb

@@ -24,6 +24,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Login.new.execute
     #

data/lib/ruby_terraform/commands/logout.rb

@@ -21,6 +21,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Logout.new.execute
     #

data/lib/ruby_terraform/commands/output.rb

@@ -29,6 +29,11 @@ module RubyTerraform
     #   to a string, will print the raw string directly, rather than a
     #   human-oriented representation of the value.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Output.new.execute(
     #     name: 'vpc_id')

data/lib/ruby_terraform/commands/plan.rb

@@ -65,6 +65,11 @@ module RubyTerraform
     #   +:var_file+ and +:var_files+ are provided, all var files will be passed
     #   to terraform.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Plan.new.execute(
     #     directory: 'infra/networking',

data/lib/ruby_terraform/commands/providers.rb

@@ -24,6 +24,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Providers.new.execute
     #

data/lib/ruby_terraform/commands/providers_lock.rb

@@ -65,6 +65,11 @@ module RubyTerraform
     #   for; see +:platform+ for more details; if both +:platform+ and
     #   +:platforms+ are provided, all platforms will be passed to Terraform.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::ProvidersLock.new.execute(
     #     fs_mirror: "/usr/local/terraform/providers",

data/lib/ruby_terraform/commands/providers_mirror.rb

@@ -39,6 +39,11 @@ module RubyTerraform
     #   see +:platform+ for more details; if both +:platform+ and +:platforms+
     #   are provided, all platforms will be passed to Terraform.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::ProvidersMirror.new.execute(
     #     directory: './plugins',

data/lib/ruby_terraform/commands/providers_schema.rb

@@ -17,6 +17,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::ProvidersSchema.new.execute(
     #     directory: 'infra/networking')

data/lib/ruby_terraform/commands/refresh.rb

@@ -56,6 +56,11 @@ module RubyTerraform
     #   +:var_file+ and +:var_files+ are provided, all var files will be passed
     #   to terraform.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Refresh.new.execute(
     #     directory: 'infra/networking',

data/lib/ruby_terraform/commands/show.rb

@@ -22,6 +22,11 @@ module RubyTerraform
     # * +:json+: if +true+, outputs the Terraform plan or state in a
     #   machine-readable form; defaults to +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Show.new.execute
     #

data/lib/ruby_terraform/commands/state_list.rb

@@ -43,6 +43,11 @@ module RubyTerraform
     #   whose resource types have an attribute named "id" whose value equals the
     #   given id string.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StateList.new.execute
     #

data/lib/ruby_terraform/commands/state_move.rb

@@ -56,6 +56,11 @@ module RubyTerraform
     #   unusable workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StateMove.new.execute(
     #     source: 'packet_device.worker',

data/lib/ruby_terraform/commands/state_pull.rb

@@ -23,6 +23,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StatePull.new.execute
     #

data/lib/ruby_terraform/commands/state_push.rb

@@ -39,6 +39,11 @@ module RubyTerraform
     #   unusable workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StatePush.new.execute(
     #     path: 'some/statefile.tfstate')

data/lib/ruby_terraform/commands/state_remove.rb

@@ -47,6 +47,11 @@ module RubyTerraform
     #   unusable workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StateRemove.new.execute(
     #     address: 'packet_device.worker')

data/lib/ruby_terraform/commands/state_replace_provider.rb

@@ -34,6 +34,11 @@ module RubyTerraform
     #   unusable workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StateReplaceProvider.new.execute(
     #     from: 'hashicorp/aws',

data/lib/ruby_terraform/commands/state_show.rb

@@ -22,6 +22,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::StateShow.new.execute(
     #     address: 'packet_device.worker')

data/lib/ruby_terraform/commands/taint.rb

@@ -58,6 +58,11 @@ module RubyTerraform
     #   unusable workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Taint.new.execute(
     #     address: 'aws_security_group.allow_all')

data/lib/ruby_terraform/commands/untaint.rb

@@ -50,6 +50,11 @@ module RubyTerraform
     #   unusable workspace, and should be used with extreme caution; defaults to
     #   +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Untaint.new.execute(
     #     name: 'aws_security_group.allow_all')

data/lib/ruby_terraform/commands/validate.rb

@@ -47,6 +47,11 @@ module RubyTerraform
     # * +:no_color+: whether or not the output from the command should be in
     #   color; defaults to +false+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Validate.new.execute(
     #     directory: 'infra/networking')

data/lib/ruby_terraform/commands/workspace_delete.rb

@@ -24,6 +24,11 @@ module RubyTerraform
     #   when +false+, does not lock the state file; defaults to +true+.
     # * +:lock_timeout+: the duration to retry a state lock; defaults to +"0s"+.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::WorkspaceDelete.new.execute(
     #     name: 'example')

data/lib/ruby_terraform/commands/workspace_list.rb

@@ -18,6 +18,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::WorkspaceList.new.execute(
     #     directory: 'infra/networking')

data/lib/ruby_terraform/commands/workspace_new.rb

@@ -23,6 +23,11 @@ module RubyTerraform
     # * +:lock_timeout+: the duration to retry a state lock; defaults to +"0s"+.
     # * +:state+: the path to a state file to copy into the new workspace.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::WorkspaceNew.new.execute(
     #     name: 'example')

data/lib/ruby_terraform/commands/workspace_select.rb

@@ -19,6 +19,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example BasicInvocation
     #   RubyTerraform::Commands::WorkspaceSelect.new.execute(
     #     name: 'example')

data/lib/ruby_terraform/commands/workspace_show.rb

@@ -16,6 +16,11 @@ module RubyTerraform
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     #
+    # The {#execute} method accepts an optional second parameter which is a map
+    # of invocation options. Currently, the only supported option is
+    # +:environment+ which is a map of environment variables to expose during
+    # invocation of the command.
+    #
     # @example Basic Invocation
     #   RubyTerraform::Commands::WorkspaceShow.new.execute
     #

data/lib/ruby_terraform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyTerraform
-  VERSION = '1.6.0.pre.2'
+  VERSION = '1.6.0.pre.5'
 end