-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): add terraform docs automation (#17)
* docs(readme): add terraform docs automation Add terraform docs script along with makefile target and gihub action for same Signed-off-by: Timothy MacDonald <[email protected]> * docs(readme): automate update and testing of README.md by terraform-docs 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 <[email protected]> --------- Signed-off-by: Timothy MacDonald <[email protected]>
- Loading branch information
Showing
6 changed files
with
84 additions
and
23 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Test that terraform docs has been run | ||
| on: push | ||
| jobs: | ||
| docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
| - name: Install terraform-docs | ||
| run: curl -L https://github.com/terraform-docs/terraform-docs/releases/download/v0.16.0/terraform-docs-v0.16.0-linux-amd64.tar.gz | (cd /usr/local/bin; tar zxvf -; chmod +x /usr/local/bin/terraform-docs) | ||
| - name: store hash of orig README.md | ||
| id: old_hash | ||
| run: echo "README_HASH=$(md5sum README.md)" >> $GITHUB_OUTPUT | ||
| - name: Update README.md using terraform-docs make target | ||
| run: make terraform-docs | ||
| - name: store hash of new README.md | ||
| id: new_hash | ||
| run: echo "README_HASH=$(md5sum README.md)" >> $GITHUB_OUTPUT | ||
| - name: echo hashes | ||
| run: | | ||
| echo ${{ steps.old_hash.outputs.README_HASH }} | ||
| echo ${{ steps.new_hash.outputs.README_HASH }} | ||
| - name: test to see of hashs are the same | ||
| if: ${{ steps.old_hash.outputs.README_HASH != steps.new_hash.outputs.README_HASH }} | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| script: | | ||
| core.setFailed('Please run "make terraform-docs" and try again') |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| formatter: "markdown" | ||
| version: "0.16.0" | ||
| output: | ||
| file: README.md |
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # | ||
| # Name:: release_helpers.sh | ||
| # Description:: A set of helper funtions to be used by our release.sh script | ||
| # Description:: A set of helper functions to be used by our release.sh script | ||
| # Author:: Salim Afiune Maya (<[email protected]>) | ||
| # | ||
|
|
||
|
|
@@ -137,6 +137,7 @@ prepare_release() { | |
| prerequisites | ||
| remove_tag_version | ||
| check_for_minor_version_bump | ||
| generate_readme | ||
| generate_release_notes | ||
| update_changelog | ||
| push_release | ||
|
|
@@ -192,6 +193,10 @@ generate_release_notes() { | |
| echo "$(cat CHANGES.md)" >> RELEASE_NOTES.md | ||
| } | ||
|
|
||
| generate_readme() { | ||
| make terraform-docs | ||
| } | ||
|
|
||
| load_list_of_changes() { | ||
| latest_version=$(find_latest_version) | ||
| local _list_of_changes=$(git log --no-merges --pretty="* %s (%an)([%h](https://github.com/${org_name}/${project_name}/commit/%H))" ${latest_version}..${main_branch}) | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
|
|
||
| if which terraform-docs >/dev/null; then | ||
| terraform-docs . | ||
| elif which docker >/dev/null; then | ||
| echo "## terraform-docs not found in PATH, but docker was found" | ||
| echo "## running terraform-docs in docker" | ||
| terraform_docs_version=$(cat .terraform-docs.yml | grep version | cut -d\" -f 2) | ||
| docker run --rm -v `pwd`:/data cytopia/terraform-docs:${terraform_docs_version} terraform-docs . | ||
| else | ||
| echo "## terraform-docs not found in PATH, neither was docker" | ||
| echo "## please install terraform-docs or docker" | ||
| exit 1 | ||
| fi |