https://github.com/sepulworld/tfmod-generator

Generates Terraform module scaffolding
https://github.com/sepulworld/tfmod-generator

cli hashicorp terraform

Last synced: 23 days ago
JSON representation

Generates Terraform module scaffolding

• Host: GitHub
• URL: https://github.com/sepulworld/tfmod-generator
• Owner: sepulworld
• License: mit
• Created: 2017-01-10T18:38:19.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-04T22:30:55.000Z (almost 6 years ago)
• Last Synced: 2024-08-17T18:14:21.710Z (3 months ago)
• Topics: cli, hashicorp, terraform
• Language: Ruby
• Size: 30.3 KB
• Stars: 7
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Tfmod::Generator

[![Build Status](https://travis-ci.org/sepulworld/tfmod-generator.svg)](https://travis-ci.org/sepulworld/tfmod-generator)

[![Gem Version](https://badge.fury.io/rb/tfmod-generator.svg)](http://badge.fury.io/rb/tfmod-generator)

## Installation

    $ gem install tfmod-generator

## Usage

To generate a git source driven Terraform module, example command:

```

$ tfmod zookeeper

      create  zookeeper/Readme.md

      create  zookeeper/CHANGELOG.md

      create  zookeeper/.gitignore

      create  zookeeper/main.tf

      create  zookeeper/outputs.tf

      create  zookeeper/variables.tf

      create  zookeeper/remote_scripts

      create  zookeeper/remote_scripts/user-data.sh.tpl

      create  zookeeper/test

      create  zookeeper/test/test.tf

         run  git init zookeeper from "."

Initialized empty Git repository in /Users/zane/src/tfmod-generator/zookeeper/.git/

/Users/zane/src/tfmod-generator/zookeeper created!

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sepulworld/tfmod-generator. 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 [MIT License](http://opensource.org/licenses/MIT).