docs(readme): add terraform docs automation #10
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
Add terraform docs script along with makefile target and gihub action for same Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
Add github action to test that README.md has been update. Also add update of README.md to /scripts/release.sh prepare Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
jon-stewart
approved these changes
Oct 10, 2023
tmac1973
changed the title
Merged
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.
Add terraform docs script along with makefile target and gihub action to test for updated README.md
Summary
This change updates the makefile and release scripts to automatically update the README.md file using terraform-docs. Additionally a github action was added to test that the README.md had been updated when pushed.
How did you test this change?
The makefile and script were tested on the command line. The github action was tested by pushing the repo.
Issue
https://lacework.atlassian.net/browse/GROW-440