Support terraform-docs updates

[dsegurag]

Type of discussion.

I'm proposing an idea

Tell us more.

Hi there!

It would be nice if Renovate supports terraform-docs updates. Right now, everytime we have a new merge/pull request we should switch to the Renovate's branch and execute the command manually.

What do you think?

Thanks in advance.

[rarkins]

Could you create a demonstration repo which shows a Pull Request with two commits?

• Renovate's original update
• Your manually docs update on top

[dsegurag]

Hi @rarkins!

Of course, here you have it: https://github.com/dsegurag/renovate-terraform-docs.

As you can see it's using the Terraform GitLab's provider 15.10.0 version. Then when Renovate creates the pull request it tries to update it to 15.11.0 as you can see here: dsegurag/renovate-terraform-docs#1.

The Renovate commit just take care about the provider version in main.tf file: dsegurag/renovate-terraform-docs@5b35425

Then, I need to switch to this branch and execute terraform-docs . command again to update the README.md file: dsegurag/renovate-terraform-docs@17ace97

Hope this is enoguht. Please let me know if you need further tests or somethign else.

[rarkins]

If you are self-hosting then you can probably solve this with postUpgradeTasks, which let you run any command.

It could be complicated for Renovate to do this automatically though. e.g. it could perhaps look for a .terraform-docs file and run terraform-docs . in a simple case, but when the file being updated is in a subfolder then it's more complicated

[dsegurag]

Hi @rarkins,

Yes, I'm using self-hosting Renovate. I confirm that I was able to update it via postUpgradeTasks. Here I post my configs, maybe can help someone:

This is how my renovate.json file looks like:

{
  "extends": [
    "config:base",
    "group:all",
    ":disableDependencyDashboard",
    ":disableRateLimiting",
  ],
  "postUpgradeTasks": {
    "commands": [
      "./renovate-post-upgrade-tasks.sh"
    ],
    "fileFilters": [
      "**/README.md",
      "**/.terraform.lock.hcl"
    ],
    "executionMode": "branch"
  },
  "regexManagers": [
    {
      "fileMatch": [
        "^renovate-post-upgrade-tasks\\.sh$"
      ],
      "matchStrings": [
        "https://releases\\.hashicorp\\.com/terraform/(?<currentValue>.*?)/terraform_([0-9]+)\\.([0-9]+)\\.([0-9]+)_linux_\\$\\(dpkg --print-architecture\\)\\.zip",
        "https://releases\\.hashicorp\\.com/terraform/([0-9]+)\\.([0-9]+)\\.([0-9]+)/terraform_(?<currentValue>.*?)_linux_\\$\\(dpkg --print-architecture\\)\\.zip"
      ],
      "depNameTemplate": "hashicorp/terraform",
      "datasourceTemplate": "docker"
    },
    {
      "fileMatch": [
        "^renovate-post-upgrade-tasks\\.sh$"
      ],
      "matchStrings": [
        "https://terraform-docs\\.io/dl/v([0-9]+)\\.([0-9]+)\\.([0-9]+)/terraform-docs-v(?<currentValue>.*?)-\\$\\(uname\\)-\\$\\(dpkg --print-architecture\\)\\.tar\\.gz",
        "https://terraform-docs\\.io/dl/v(?<currentValue>.*?)/terraform-docs-v([0-9]+)\\.([0-9]+)\\.([0-9]+)-\\$\\(uname\\)-\\$\\(dpkg --print-architecture\\)\\.tar\\.gz"
      ],
      "depNameTemplate": "quay.io/terraform-docs/terraform-docs",
      "datasourceTemplate": "docker"
    }
  ]
}

And here you have the content of renovate-post-upgrade-tasks.sh file:

#!/usr/bin/env sh

# terraform
curl -sqLo /tmp/terraform.zip "https://releases.hashicorp.com/terraform/1.4.6/terraform_1.4.6_linux_$(dpkg --print-architecture).zip"
unzip /tmp/terraform.zip -d /tmp/
/tmp/terraform init -backend=false
/tmp/terraform providers lock -platform=linux_amd64 -platform=linux_arm64 -platform=darwin_amd64 -platform=darwin_arm64

# terraform-docs
curl -sqLo /tmp/terraform-docs.tar.gz "https://terraform-docs.io/dl/v0.16.0/terraform-docs-v0.16.0-$(uname)-$(dpkg --print-architecture).tar.gz"
tar -xzf /tmp/terraform-docs.tar.gz -C /tmp/
chmod +x /tmp/terraform-docs
/tmp/terraform-docs .

And also I added the RENOVATE_ALLOWED_POST_UPGRADE_COMMANDS='["./renovate-post-upgrade-tasks.sh"]' environment variable on my global config.

Many thanks!

[viceice]

you can use regex manager to update the versions inside readme file.

[jlamande]

Hi @viceice

as a newbie on renovate (which looks great !), I'll be very interested for a sample with regex manager on this case.

My README.md file contains those lines (generated by terraform docs) :

| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.14 |

| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.14 |

Renovate suggests the upgrade of ~> 4.14 to ~> 5.0 in my terraform file (through the terraform manager I suppose).

But I don't get how to link this with the regex manager in the README.md.

[jlamande]

sry for the direct mention

[viceice]

please open a new discussion with a reproduction, that makes it much easier to solve your issue.

[github-actions[bot]]

Hi there,

Please do not unnecessarily @ mention maintainers like @rarkins or @viceice. Doing so causes annoying mobile notifications and makes it harder to maintain this repository.

For example, never @ mention a maintainer when you are creating a discussion if your desire is to get attention. This is rude behavior, just like shouting out your coffee order in a Starbucks before it's your turn.

It's OK to comment in an issue or discussion after multiple days or weeks. But please, still don't @ mention people. The maintainers try to answer most discussions, but they can't answer all discussions. If you're still not getting an answer, take a look at the information you've given us and see if you can improve it.

Thanks, the Renovate team

[jlamande]

I'll be careful next time