generated from baikonur-oss/terraform-aws-template
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8d9c0f1
Showing
6 changed files
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
### macOS | ||
.DS_Store | ||
._* | ||
|
||
### JetBrains | ||
.idea | ||
|
||
### Terraform | ||
.terraform | ||
*.tfstate* | ||
terraform.tfstate | ||
terraform.tfvars | ||
|
||
### Python | ||
venv/ | ||
.pyc | ||
|
||
### Others | ||
build/ | ||
package.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
repos: | ||
- repo: git://github.com/antonbabenko/pre-commit-terraform | ||
rev: v1.7.3 | ||
hooks: | ||
- id: terraform_fmt | ||
- id: terraform_docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 Baikonur | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# AWS %description% Terraform module | ||
|
||
Terraform module for %long_description% | ||
|
||
![terraform v0.11.x](https://img.shields.io/badge/terraform-v0.11.x-brightgreen.svg) | ||
|
||
## Usage | ||
|
||
```HCL | ||
resource "aws_s3_bucket" "bucket" { | ||
bucket = "test" | ||
} | ||
``` | ||
|
||
### Version pinning | ||
#### Terraform Module Registry | ||
Use `version` parameter to pin to a specific version, or to specify a version constraint when pulling from [Terraform Module Registry](https://registry.terraform.io) (`source = baikonur-oss/%module_name%/aws`). | ||
For more information, refer to [Module Versions](https://www.terraform.io/docs/configuration/modules.html#module-versions) section of Terraform Modules documentation. | ||
|
||
#### GitHub URI | ||
Make sure to use `?ref=` version pinning in module source URI when pulling from GitHub. | ||
Pulling from GitHub is especially useful for development, as you can pin to a specific branch, tag or commit hash. | ||
Example: `source = github.com/baikonur-oss/%repo_name%?ref=v1.0.0` | ||
|
||
For more information on module version pinning, see [Selecting a Revision](https://www.terraform.io/docs/modules/sources.html#selecting-a-revision) section of Terraform Modules documentation. | ||
|
||
|
||
<!-- Documentation below is generated by pre-commit, do not overwrite manually --> | ||
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
|
||
## Contributing | ||
|
||
Make sure to have following tools installed: | ||
- [Terraform](https://www.terraform.io/) | ||
- [terraform-docs](https://github.com/segmentio/terraform-docs) | ||
- [pre-commit](https://pre-commit.com/) | ||
|
||
### macOS | ||
```bash | ||
brew install pre-commit terraform terraform-docs | ||
|
||
# set up pre-commit hooks by running below command in repository root | ||
pre-commit install | ||
``` |
Empty file.
Empty file.