Skip to content

Commit

Permalink
Add docs generation action
Browse files Browse the repository at this point in the history
  • Loading branch information
IsaacCalligeros95 committed Jul 30, 2024
1 parent 434f6cb commit d554436
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
19 changes: 19 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Generate terraform docs
on:
- pull_request

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.ref }}

- name: Render terraform docs and push changes back to PR
uses: terraform-docs/gh-actions@main
with:
working-dir: .
output-file: README.md
output-method: inject
git-push: "true"
2 changes: 1 addition & 1 deletion docs/resources/aws_elastic_container_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ resource "octopusdeploy_aws_elastic_container_registry" "example" {

- `access_key` (String) The AWS access key to use when authenticating against Amazon Web Services.
- `name` (String) The name of this resource.
- `region` (String) The AWS region where the registry resides.
- This should be fixed
- `secret_key` (String, Sensitive) The AWS secret key to use when authenticating against Amazon Web Services.

### Optional
Expand Down

0 comments on commit d554436

Please sign in to comment.