Add ATX Header Support for terraform-docs
#164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a temporary fix until @mcdonnnj has his PR approved and merged into the terraform-docs repo. This fix will perform a shallow clone of his forked branch, build the binary, and install it.
michaelsaki
added
documentation
michaelsaki
requested review from
dav3r,
felddy,
jasonodoom,
jsf9k and
mcdonnnj
as code owners
mcdonnnj
requested changes
Jan 22, 2024
Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>
PATH is handled by `setup-go` so we can refactor the code setting it. Also we are taking advantage of the -C switch to handle building from the cloned repository. Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>
dav3r
reviewed
Jan 22, 2024
dav3r
reviewed
Jan 22, 2024
jsf9k
approved these changes
Jan 22, 2024
3 tasks
`TODO` was placed on the wrong comment block. Also I am adding a link to the issue for the TODO.
Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
dav3r
approved these changes
Jan 23, 2024
You are welcome! Yes, I ran any changes to the workflow in act, everything checked out locally. |
mcdonnnj
deleted the
improvement/install_atx_header_support_terraform-docs
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
This pull request:
terraform-docs.💭 Motivation and context
This temporarily resolves #196 until @mcdonnnj's changes get merged into
terraform-docs, at which point we can change back over to the standard of installingterraform-docs.🧪 Testing
All automated tests passed. I also used act for local testing to make sure the workflow would behave like it should.
✅ Pre-approval checklist
to reflect the changes in this PR.
✅ Pre-merge checklist
✅ Post-merge checklist