Skip to content

feature/terraform docs hcl2 #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feature/terraform docs hcl2 #5

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
141ad73
remove terraform0.12 helper and adopt command for terraform-docs v0.8.0
tbugfinder Jan 15, 2020
85b0789
change to lowercase in alignment with terraform-docs
tbugfinder Jan 15, 2020
45f054a
update documentation
tbugfinder Jan 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update documentation
  • Loading branch information
@tbugfinder
tbugfinder committed Jan 15, 2020
commit 45f054a6f5c36c18d3dd26149011c2c706a3b7cc
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ This project contains some useful hooks for https://pre-commit.com.

The `terraform_inputs_jenkins_pipeline_params` hook supports the definition of a [Declarative Jenkins Pipeline](https://jenkins.io/doc/book/pipeline/syntax/#declarative-pipeline)'s [parameters](https://jenkins.io/doc/book/pipeline/syntax/#parameters) from your [Terraform Input Variables](https://www.terraform.io/intro/getting-started/variables.html).

*Note:*
1. Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.4.0.
2. Requires [terraform-docs12](https://raw.githubusercontent.com/marcuscaisey/.dotfiles/master/scripts/terraform-docs12)
*Note:* Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.8.0.

### Sample Usage

Expand All @@ -17,7 +15,7 @@ The `terraform_inputs_jenkins_pipeline_params` hook supports the definition of a
```
repos:
- repo: git://github.com/getcloudnative/pre-commit-hooks
rev: v1.2.0
rev: v1.4.0
hooks:
- id: terraform_inputs_jenkins_pipeline_params
```
Expand Down Expand Up @@ -46,7 +44,7 @@ pipeline {

The `terraform_inputs_jenkins_pipeline_params` hook supports the creation of a [terraform.tfvars.json](https://www.terraform.io/intro/getting-started/variables.html#from-a-file) based on your [Terraform Input Variables](https://www.terraform.io/intro/getting-started/variables.html), with values provided by the Jenkins Pipeline parameters' arguments.

*Note:* Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.4.0.
*Note:* Requires [segmentio/terraform-docs](https://github.com/segmentio/terraform-docs) >= v0.8.0.

### Sample Usage

Expand All @@ -55,7 +53,7 @@ The `terraform_inputs_jenkins_pipeline_params` hook supports the creation of a [
```
repos:
- repo: git://github.com/getcloudnative/pre-commit-hooks
rev: v1.2.0
rev: v1.4.0
hooks:
- id: terraform_inputs_jenkins_pipeline_params
```
Expand Down