Skip to content
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.

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

Upgrade terraform-docs to v0.15.0 #59

Merged
merged 1 commit into from
Aug 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/templates/README.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ branch.

## Version

`{{ $version }}` (uses [terraform-docs] v0.14.1, which is supported and tested on Terraform
`{{ $version }}` (uses [terraform-docs] v0.15.0, which is supported and tested on Terraform
version 0.11+ and 0.12+ but may work for others.)

{{- if eq $version "main" }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ jobs:
with:
working-dir: examples/tf12_inject
output-file: README.md
args: --sort-by-required
args: --sort-by required
indention: 3
git-push: true
git-push-sign-off: true
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

FROM quay.io/terraform-docs/terraform-docs:0.14.1
FROM quay.io/terraform-docs/terraform-docs:0.15.0

# this is explicitly needed because yq v4.x only exists in this repo.
RUN echo "http://dl-4.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ branch.

## Version

`v0.9.0` (uses [terraform-docs] v0.14.1, which is supported and tested on Terraform
`v0.9.0` (uses [terraform-docs] v0.15.0, which is supported and tested on Terraform
version 0.11+ and 0.12+ but may work for others.)

## Usage
Expand Down
50 changes: 25 additions & 25 deletions examples/tf12_inject/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Test Inject
## Input
```yaml
- name: Should generate README.md for tf12_inject and push up all changes
uses: ./
with:
working-dir: examples/tf12_inject
output-file: README.md
args: --sort-by-required
indention: 3
git-push: true
git-commit-message: "terraform-docs: automated action"
```
## Verify
- Should inject below Usage
- Should push up changes on build with commit message 'terraform-docs: automated action'
## Usage
<!--- BEGIN_TF_DOCS --->
# Test Inject

## Input

```yaml
- name: Should generate README.md for tf12_inject and push up all changes
uses: ./
with:
working-dir: examples/tf12_inject
output-file: README.md
args: --sort-by required
indention: 3
git-push: true
git-commit-message: "terraform-docs: automated action"
```

## Verify

- Should inject below Usage
- Should push up changes on build with commit message 'terraform-docs: automated action'

## Usage

<!--- BEGIN_TF_DOCS --->
### Requirements

| Name | Version |
Expand Down Expand Up @@ -64,4 +64,4 @@ No modules.
|------|-------------|
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The Id of the VPC |

<!--- END_TF_DOCS --->
<!--- END_TF_DOCS --->