-
Notifications
You must be signed in to change notification settings - Fork 565
Description
Describe the bug
GitHub disabled recently bare git urls https://github.blog/2021-09-01-improving-git-protocol-security-github. Sources for public modules not available from https://registry.terraform.io are using git source. This caused diff in module source git://github.com -> git::https://github.com
.
I use autogenerated Readme.md with terraform-docs markdown . > README.md
, which causes this diff in it: | <a name="module_xxx"></a> [idp](#module\_xxx) | git://github.com/xxx | 1.0.0 | -> | <a name="module_xxx"></a> [idp](#module\_xxx) | git::https://github.com/xxx | 1.0.0 |
Which is turn, caused markdownlint error MD034 - Bare URL used
https://github.com/updownpress/markdown-lint/blob/master/rules/034-no-bare-urls.md
I was able to hot fix it by adding * <!-- markdownlint-disable MD034 -->
to JSDoc header in main.tf, but maybe it could be handled somehow on terraform-docs side?
How can we reproduce it?
- Add source to public module via
source = "git::https://github.com/something/module"
- Generate docs with
terraform-docs markdown . > README.md
- Run markdown-lint
- Get
MD034 - Bare URL used
https://github.com/updownpress/markdown-lint/blob/master/rules/034-no-bare-urls.md
Environment information
- terraform-docs version v0.16.0 darwin/amd64
- OS: MacOS