diff --git a/.github/workflows/website-deploy-preview.yml b/.github/workflows/website-deploy-preview.yml index 3eefd20b0..af32ee77a 100644 --- a/.github/workflows/website-deploy-preview.yml +++ b/.github/workflows/website-deploy-preview.yml @@ -78,6 +78,10 @@ jobs: run: | ./scripts/render-docs-for-components.sh + - name: "Render Documentation for Terraform Components Change Log" + run: | + ./scripts/render-docs-for-changelog.sh + - name: "Render Documentation for Terraform Modules" env: PUBLIC_REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }} diff --git a/changelog/.gitkeep b/changelog/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/content/components/library/upgrade-guide.md b/content/components/library/upgrade-guide.md new file mode 100644 index 000000000..e967e864e --- /dev/null +++ b/content/components/library/upgrade-guide.md @@ -0,0 +1,6 @@ +--- +title: Upgrade Guide +sidebar_label: Upgrade Guide +description: Upgrade Guide +sidebar_position: 10 +--- diff --git a/scripts/render-docs-for-changelog.sh b/scripts/render-docs-for-changelog.sh new file mode 100755 index 000000000..0caa3f2c4 --- /dev/null +++ b/scripts/render-docs-for-changelog.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +set -e + +GITHUB_REPO=${GITHUB_REPO:-"terraform-aws-components"} +TMP_CLONE_DIR="${TMP_CLONE_DIR:-tmp/components/${GITHUB_REPO}}" +INPUT_UPGRADE_GUIDE_FILE="${INPUT_UPGRADE_GUIDE_FILE:-${TMP_CLONE_DIR}/docs/upgrade-guide.md}" +OUTPUT_UPGRADE_GUIDE_FILE="content/components/library/upgrade-guide.md" +FRONT_MATTER=$(cat < "${OUTPUT_UPGRADE_GUIDE_FILE}" +cat "${INPUT_UPGRADE_GUIDE_FILE}" >> "${OUTPUT_UPGRADE_GUIDE_FILE}" \ No newline at end of file