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

chore: update documentation based on latest terraform-docs which includes module and resource sections #108

Conversation

bryantbiggs
Copy link
Member

Description

  • update documentation based on latest terraform-docs which includes module and resource sections
  • .gitignore updated using GitHub provided default standard + 0.14 lockfile ignore

Motivation and Context

Breaking Changes

No

How Has This Been Tested?

N/A

@antonbabenko
Copy link
Member

I see that my terraform-docs decided to reorder couple of elements now. I think it is correct that datasources are coming before resources.

$ terraform-docs --version                  

terraform-docs version v0.11.0 darwin/amd64 BuildDate: 2021-02-11T00:17:03+0000

@antonbabenko antonbabenko merged commit 89337b2 into terraform-aws-modules:master Feb 18, 2021
@bryantbiggs bryantbiggs deleted the chore/update-terraform-docs branch February 18, 2021 15:22
@antonbabenko
Copy link
Member

Something weird is going on with this :)

I see that it is actually trying to update the same file multiple times because the order is not consistent.

# on master branch
 pre-commit run -a --verbose terraform_docs
Terraform docs...........................................................Failed
- hook id: terraform_docs
- duration: 2.43s
- files were modified by this hook

aws_iam_role resource and data-source are swapping the positions every time I rerun the command.

Maybe there should be some extra flag passed to terraform-docs?

@bryantbiggs
Copy link
Member Author

ah, looks like a small bug. hopefully a patch release is sent out soon terraform-docs/terraform-docs#393

@bryantbiggs
Copy link
Member Author

looks like this might be solved now if you update to the latest @antonbabenko https://github.com/terraform-docs/terraform-docs/releases/tag/v0.11.1

@antonbabenko
Copy link
Member

Thanks! Yes, now it works.

Should I also update docs in all of your similar PRs? Or are those already correct if I use 0.11.1?

@bryantbiggs
Copy link
Member Author

@antonbabenko I just went through them yesterday evening to re-run pre-commit run -a so I *think they should correct (I hope). There were a few that did update, and a few that did not

@antonbabenko
Copy link
Member

Great work! I will merge them later today/tomorrow.

@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants