cloudposse / terraform-aws-dynamic-subnets

Terraform module for public and private subnets provisioning in existing VPC
https://cloudposse.com/accelerate
Apache License 2.0
197 stars 167 forks source link

docs: update ipv4_cidr_block to a list #167

Closed morremeyer closed 2 years ago

morremeyer commented 2 years ago

what

why

additional info

I tried to run make init && make readme to generate the README, however make readme fails with:

❯ make readme
* Package gomplate already installed
* Package terraform-docs already installed
make: gomplate: No such file or directory
make: *** [readme/build] Error 1

on my machine. (MacBook Pro, macOS Monterey 12.4)

joe-niland commented 2 years ago

/test all

joe-niland commented 2 years ago

@morremeyer I know it's not relevant to your change but the tests failed due to a missing terraform version attribute in example/complete. Could you please copy versions.tf from the project root to the examples/complete and examples/existing-ip directories?

morremeyer commented 2 years ago

@joe-niland Sure, no problem :)

joe-niland commented 2 years ago

/test bats

joe-niland commented 2 years ago

/test all

joe-niland commented 2 years ago

Thanks very much @morremeyer, looks good! I will ask one of the Code owners to review.

btw, if you feel like raising the gomplate issue.

aknysh commented 2 years ago

/test all

Nuru commented 2 years ago

@morremeyer @joe-niland Regarding the make readme issue, make readme runs tools (such as gomplate) on the host to build the README.md file and will fail if you do not have them installed. You can, instead, run make pr/readme which will run the tools inside the build-harness Docker container and should work in more situations.

joe-niland commented 2 years ago

@Nuru thanks. Should make readme/deps handle the native dependency install? I remember trying this unsuccessfully and just installed via brew.

Anyway, thanks for the pointer on the docker option - that sounds preferable.

morremeyer commented 2 years ago

I would advise against that, I wouldn't want a "generate Textfile" command to install Software without it being documented explicitly.

A make setup or similar, or just documentation about which dependencies need to be installed would be much better in my opinion.