feat: add terradoc #89
Conversation
| default = false | ||
| } | ||
|
|
||
| variable "auto_init" { |
There was a problem hiding this comment.
Those kind of code changes require adjustments in the main.tf also since we're checking for null there. Also, it should be added to the Changelog.md - may I ask you why we decided to implement those changes?
There was a problem hiding this comment.
@soerenmartius The documentation consistently put false where variables.tf had null. It looked like a mistake to me, like someone forgot to add the defaults in variables.tf. But it seems it was the other way around and the documentation was wrong. I will change it back and change the documentation.
There was a problem hiding this comment.
yeah that seems to be the case! Sorry for the confusion - this was obviously already faulty in the first place! Thank you!
There was a problem hiding this comment.
Ah, I had a look at main.tf and it sets the defaults there. Now I get why it's like that.
There was a problem hiding this comment.
@soerenmartius Actually the documentation is correct since if no default is set it will default to whatever the documentation says. It just does so in main.tf which I did not realize.
There was a problem hiding this comment.
makes sense! Thanks for the clarification!
There was a problem hiding this comment.
Eg:
In main.tf:
has_wiki = var.has_wiki == null ? lookup(var.defaults, "has_wiki", false) : var.has_wiki
And in the documentation:
variable "has_wiki" { type = bool default = false description = <<-END Set to true to enable the GitHub Wiki features on the repository. END }
So it does set it to false if it can't find has_wiki in var.defaults, hence the documentation is correct.
kassianh
dismissed
soerenmartius’s stale review
Reverted defaults in latest commit.
soerenmartius
left a comment
soerenmartius
left a comment
There was a problem hiding this comment.
Very good job! Just a minor hint for the wrong version in the Readme. Would be great if @mariux could provide a second review.
Co-authored-by: Sören Martius <soeren.martius@gmail.com>
|
Sorry, i hadn't run terradoc yet to update the readme |
|
Any idea why the checks are failing @soerenmartius ? |
Recreated README with terradoc, checked documentation for errors or inconsistencies.