Repository files navigation

This gem provides aterrafile executable (Ruby) to install a Terraform project's modules usinggit.

The idea of using a 'Terrafile' (like a 'Puppetfile' or a 'Gemfile') to manage a project's dependencies comes from Ben Snape and this code is based on his blog posthttp://bensnape.com/2016/01/14/terraform-design-patterns-the-terrafile/.

Conventions:

• a project's modules are described in aTerrafile located at the root of the project
• terraform modules are installed invendor/terraform_modules

Add this line to your application's Gemfile:

gem'terrafile'

And then execute:

$ bundle

Or install it yourself as:

$ gem install terrafile

Invoke the executable from your shell:

$ terrafile

to install the modules listed inTerrafile intovendor/terraform_modules.

• git
• Ruby (>= 2.7.6)

To install this gem onto your local machine, runbundle exec rake install. To release a new version, update the version number inversion.rb, and then runbundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the.gem file torubygems.org.

• gem build terrafile.gemspec
• gem install terrafile-*.gem

Then you can run$ terrafile to run the latest version

Run the test suite with:

rake test

The task will:

• run unit tests with 'rspec'
• enforce 100% coverage with 'simplecov'
• lint the Ruby code with 'rubocop'
• run integration tests with 'cucumber'

Bug reports and pull requests are welcome on GitHub athttps://github.com/dxw/terrafile. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to theContributor Covenant code of conduct.

The gem is available as open source under the terms of theMIT License.

Everyone interacting in the Terrafile project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow thecode of conduct.