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.

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

Jump to bottom

chore: prepare release v1.1.0 #126

Merged
merged 1 commit into from
Mar 23, 2024
Merged

chore: prepare release v1.1.0 #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ branch.

## Version

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

### Upgrade v0 to v1
Expand Down Expand Up @@ -42,7 +42,7 @@ jobs:
ref: ${{ github.event.pull_request.head.ref }}

- name: Render terraform docs inside the README.md and push changes back to PR branch
uses: terraform-docs/gh-actions@v1.0.0
uses: terraform-docs/gh-actions@v1.1.0
with:
working-dir: .
output-file: README.md
Expand Down Expand Up @@ -147,7 +147,7 @@ To enable you need to ensure a few things first:

```yaml
- name: Generate TF Docs
uses: terraform-docs/gh-actions@v1.0.0
uses: terraform-docs/gh-actions@v1.1.0
with:
working-dir: .
```
Expand All @@ -156,7 +156,7 @@ To enable you need to ensure a few things first:

```yaml
- name: Generate TF Docs
uses: terraform-docs/gh-actions@v1.0.0
uses: terraform-docs/gh-actions@v1.1.0
with:
working-dir: .,example1,example3/modules/test
```
Expand All @@ -165,7 +165,7 @@ To enable you need to ensure a few things first:

```yaml
- name: Generate TF docs
uses: terraform-docs/gh-actions@v1.0.0
uses: terraform-docs/gh-actions@v1.1.0
with:
atlantis-file: atlantis.yaml
```
Expand All @@ -174,7 +174,7 @@ To enable you need to ensure a few things first:

```yaml
- name: Generate TF docs
uses: terraform-docs/gh-actions@v1.0.0
uses: terraform-docs/gh-actions@v1.1.0
with:
find-dir: examples/
```
Expand All @@ -183,13 +183,13 @@ To enable you need to ensure a few things first:

```yaml
- name: Generate TF docs
uses: terraform-docs/gh-actions@v1.0.0
uses: terraform-docs/gh-actions@v1.1.0
with:
working-dir: examples/
recursive: true
recursive-path: modules
```

Complete examples can be found [here](https://github.com/terraform-docs/gh-actions/tree/v1.0.0/examples).
Complete examples can be found [here](https://github.com/terraform-docs/gh-actions/tree/v1.1.0/examples).

[terraform-docs]: https://github.com/terraform-docs/terraform-docs
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ outputs:

runs:
using: docker
image: "docker://quay.io/terraform-docs/gh-actions:edge"
image: "docker://quay.io/terraform-docs/gh-actions:1.1.0"
env:
INPUT_WORKING_DIR: ${{ inputs.working-dir }}
INPUT_ATLANTIS_FILE: ${{ inputs.atlantis-file }}
Expand Down