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

[86azx1q5c] Implement temporary workaround for broken terraform-docs workflow #15

Merged
merged 1 commit into from
Apr 12, 2024

Conversation

kngatineau
Copy link
Owner

@kngatineau kngatineau commented Apr 1, 2024

Changes

Rebased to clean up commits, however, I am still tinkering around with the config file and getting the README to generate correctly in the root directory versus in tf/, where all the .tf files currently live

@kngatineau kngatineau self-assigned this Apr 1, 2024
@kngatineau kngatineau force-pushed the 86azx1q5c/fix-terraform-docs-workflow branch 3 times, most recently from 94a3a46 to f0114a4 Compare April 12, 2024 02:34
terraform-docs currently has a bug that will not allow a subdirectory to generate README files to be places in the root directory. For now we will generate the auto documentation in the tf/ directory and add a link in the root directory until I can find time to tinker with this more.
@kngatineau kngatineau force-pushed the 86azx1q5c/fix-terraform-docs-workflow branch from f0114a4 to c01a611 Compare April 12, 2024 02:54
Copy link
Contributor

Terraform Cloud Plan Output

Plan: 0 to add, 0 to change, 2 to destroy.

Terraform Cloud Plan

@kngatineau
Copy link
Owner Author

Rebased a jillion times because I had a bunch of experimental commits I needed to delete.

I have done research on the issue I am facing (being unable to generate the README.md in the root directory from the contents of tf/) and this GitHub Issue describes my issue with similar error output and has been officially tagged as a bug.

The .config directory at the root is now redundant until I am able to find a workaround for this, so it has been removed.

Merging.

@kngatineau kngatineau merged commit 827dcff into main Apr 12, 2024
2 checks passed
@kngatineau kngatineau changed the title [86azx1q5c] Fix broken terraform-docs workflow [86azx1q5c] Implement temporary workaround for broken terraform-docs workflow Apr 12, 2024
@kngatineau kngatineau deleted the 86azx1q5c/fix-terraform-docs-workflow branch April 12, 2024 02:57
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.

1 participant