Add an option to use a custom path for README.md using terraform_docs

[achaussier]

Hello,

First, thanks for this useful project !

Can it be possible to add a custom path for README.md when using terraform_docs hook ?

This use case can appears when Terraform files are in a subfolder, but the repository only host a single module, ex:

.
├── .gitignore
├── .gitlab-ci.yml
├── .pre-commit-config.yaml
├── README.md
└── src
    ├── main.tf
    ├── outputs.tf
    └── variables.tf

My different tries tends to use a dedicated README.md in the .tf files folder and reference it using a link inside the top level README.md file, but I foud the result less readable.

Thanks

[uridium]

Same here.
That is especially needed if you use Terraform Cloud and select "Only trigger runs when files in specified paths change".

[MaxymVlasov]

Hi @achaussier, @uridium
You can just create a symlink like ln -s src/README.md README.md in the repo root.

And I think is not a very good idea do not to have module README at the same level as the module.
The root README can have some docs like "how to contribute" and so on, when module README should contain details only related to the module.

[MaxymVlasov]

Relates to #7

[github-actions]

This issue has been automatically marked as stale because it has been open 30 days
with no activity. Remove stale label or comment or this issue will be closed in 10 days

[github-actions]

This issue was automatically closed because of stale in 10 days