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

Allow Renovate PRs to commit terraform-docs changes #15

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

Stretch96
Copy link
Member

  • When Renovate opens a PR to update Terraform dependencies, the terraform-docs check can fail, if the documentation needs updating to reflect the new dependency version.
  • This checks the branch name, and runs the terraform-docs action with git-push set to true.
  • A github token is required, set as a secret (TERRAFORM_DOCS_RENOVATE_WORKFLOW_GITHUB_TOKEN) so that the checks are ran again after it pushes it's commit. It won't end up in an endless loop, because terraform-docs won't need to make another commit when there aren't any changes.

* When Renovate opens a PR to update Terraform dependencies, the
  terraform-docs check can fail, if the documentation needs updating to
  reflect the new dependency version.
* This checks the branch name, and runs the terraform-docs action with
  `git-push` set to true.
* A github token is required, set as a secret (`TERRAFORM_DOCS_RENOVATE_WORKFLOW_GITHUB_TOKEN`)
  so that the checks are ran again after it pushes it's commit. It won't
  end up in an endless loop, because terraform-docs won't need to make
  another commit when there aren't any changes.
@Stretch96 Stretch96 merged commit d86f1e7 into main Oct 17, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants