Repo sync (#548)

hashibot-web · web-flow · commit 514672a01686 · 2025-07-07T15:24:11.000-05:00
This is an automated pull request to sync changes between the public and
private unified docs repos.

To preserve continuity across repos, _do not squash_ this pull request.
diff --git a/.github/workflows/copy-cloud-docs-for-tfe.yml b/.github/workflows/copy-cloud-docs-for-tfe.yml
@@ -14,16 +14,24 @@ on:
         required: true
         type: string
     outputs:
-      docs_branch_name:
+      release_branch_name:
         description: 'The name of the branch created for the new TFE version docs.'
-        value: ${{ jobs.copy-docs.outputs.docs_branch_name }}
+        value: ${{ jobs.copy-docs.outputs.release_branch_name }}
+      release_branch_pr_url:
+        description: 'The URL of the release branch created for the new TFE version docs.'
+        value: ${{ jobs.copy-docs.outputs.release_branch_pr_url }}
+      diff_branch_pr_url:
+        description: 'The URL of the diff branch created for the new TFE version docs.'
+        value: ${{ jobs.copy-docs.outputs.diff_branch_pr_url }}
 
 jobs:
   copy-docs:
     name: Copy Docs
     runs-on: ubuntu-latest
     outputs:
-      docs_branch_name: ${{ steps.open-docs-pr.outputs.docs_branch_name }}
+      release_branch_name: ${{ steps.open-docs-pr.outputs.docs_branch_name }}
+      release_branch_pr_url: ${{ steps.open-docs-pr.outputs.release_branch_pr_url }}
+      diff_branch_pr_url: ${{ steps.open-diff-pr.outputs.diff_branch_pr_url }}
     steps:
       - name: Series/Release Summary
         run: |
@@ -49,15 +57,21 @@ jobs:
 
       - name: Create the new TFE version folder for RELEASE PR
         run: |
+          prev_version=$(jq -r '.["terraform-enterprise"][] | select(.isLatest == true) | .version' "${{github.workspace}}/new-docs-pr/app/api/versionMetadata.json")
+          echo "Previous terraform-enterprise version: ${prev_version}"
+          echo "PREV_TFE_VERSION=${prev_version}" >> $GITHUB_ENV
+
           mkdir -p "${{github.workspace}}/new-docs-pr/content/terraform-enterprise/${{inputs.version}}"
 
-      - name: Open new version DOCS PR
+          cp -a "${{github.workspace}}/new-docs-pr/content/terraform-enterprise/${prev_version}/." "${{github.workspace}}/new-docs-pr/content/terraform-enterprise/${{inputs.version}}"
+
+      - name: Open new version RELEASE PR
         id: open-docs-pr
         working-directory: '${{github.workspace}}/new-docs-pr'
         env:
-          docs_branch_name: docs/${{inputs.version}}
+          docs_branch_name: tfe-release/${{inputs.version}}
           docs_pr_body: |
-            # Automated Docs Release PR for TFE ${{inputs.version}}
+            # TFE Release ${{inputs.version}}
 
             ...Waiting for the diff PR to be created, before finishing this PR's description...
 
@@ -78,20 +92,21 @@ jobs:
           git checkout -b ${{env.docs_branch_name}}
           git add .
 
-          git commit -m "Automated Release Docs PR" --no-verify
+          git commit -m "TFE Release ${{inputs.version}}" --no-verify
           git push origin HEAD
 
           gh pr create \
             --body="${{env.docs_pr_body}}" \
-            --title="Automated Docs Release PR for TFE ${{inputs.version}}" \
+            --title="TFE Release ${{inputs.version}}" \
             --draft \
             --head ${{env.docs_branch_name}} \
             --base main
 
           echo "docs_branch_name=${{env.docs_branch_name}}" >> $GITHUB_OUTPUT
           docs_pr_url=$(gh pr view --json url --jq '.url')
           echo "DOCS_PR_URL=${docs_pr_url}" >> $GITHUB_ENV
-          echo "**Automated Docs PR URL**: ${docs_pr_url}" >> $GITHUB_STEP_SUMMARY
+          echo "release_branch_pr_url=${docs_pr_url}" >> $GITHUB_OUTPUT
+          echo "**TFE Release PR URL**: ${docs_pr_url}" >> $GITHUB_STEP_SUMMARY
 
       # MAKE THE DIFF PR
       - name: Checkout main for new docs version DIFF PR
@@ -101,19 +116,20 @@ jobs:
           ref: '${{steps.open-docs-pr.outputs.docs_branch_name}}'
 
       - name: Copy files for new docs version DIFF PR
-        uses: ./release/.github/actions/copy-cloud-docs-for-tfe
+        uses: ./new-docs-pr/.github/actions/copy-cloud-docs-for-tfe
         with:
           source_path: '${{github.workspace}}/new-docs-pr'
           target_path: '${{github.workspace}}/new-docs-diff-pr'
           new_TFE_version: ${{inputs.version}}
 
       - name: Open new docs version DIFF PR
+        id: open-diff-pr
         working-directory: '${{github.workspace}}/new-docs-diff-pr'
         env:
           docs_branch_name: ${{steps.open-docs-pr.outputs.docs_branch_name}}
-          diff_branch_name: docs-diff/${{inputs.version}}
+          diff_branch_name: HCPTF-diff/${{inputs.version}}
           diff_pr_body: |
-            # Automated Docs Diff PR for TFE ${{inputs.version}}
+            # HCP TF changes for TFE release ${{inputs.version}}
 
             This PR was created via:
             - ${{github.server_url}}/${{github.repository}}/actions/runs/${{github.run_id}}
@@ -144,31 +160,34 @@ jobs:
           git checkout -b ${{env.diff_branch_name}}
           git add .
 
-          git commit -m "Automated Docs Diff PR" --no-verify
+          git commit -m "HCP TF changes for TFE release" --no-verify
           git push origin HEAD
 
           gh pr create \
             --body="${{env.diff_pr_body}}" \
-            --title="Automated Docs Diff PR for TFE ${{inputs.version}}" \
+            --title="HCP TF changes for TFE release ${{inputs.version}}" \
             --draft \
             --head ${{env.diff_branch_name}} \
             --base ${{env.docs_branch_name}}
 
           diff_pr_url=$(gh pr view --json url --jq '.url')
           echo "DIFF_PR_URL=${diff_pr_url}" >> $GITHUB_ENV
-          echo "**Automated DIFF PR URL**: ${diff_pr_url}" >> $GITHUB_STEP_SUMMARY
+          echo "diff_branch_pr_url=${diff_pr_url}" >> $GITHUB_OUTPUT
+          echo "**HCP TF changes for TFE release PR URL**: ${diff_pr_url}" >> $GITHUB_STEP_SUMMARY
 
-      - name: Update DOCS PR with DIFF PR URL
+      - name: Update RELEASE PR with DIFF PR URL
         env:
           docs_pr_body: |
-            # Automated Docs Release PR for TFE ${{inputs.version}}
+            # TFE Release ${{inputs.version}}
 
             This PR was created via:
             - ${{github.server_url}}/${{github.repository}}/actions/runs/${{github.run_id}}
 
             Changes since last release, diff PR:
             - ${{ env.DIFF_PR_URL }}
 
+            ❗ This is the Release PR that will be merged into main, once the release notes and diff PR are merged into it. ❗
+
             ### Reviewers
             - [ ] @hashicorp/ptfe-review
             - [ ] @hashicorp/web-platform
diff --git a/.github/workflows/create-tfe-release-notes.yml b/.github/workflows/create-tfe-release-notes.yml
@@ -43,6 +43,12 @@ jobs:
       needs: copy-docs
       runs-on: ubuntu-latest
       steps:
+        - name: Print outputs from copy-docs
+          run: |
+            echo "release_branch_name: ${{ needs.copy-docs.outputs.release_branch_name }}"
+            echo "diff_branch_pr_url: ${{ needs.copy-docs.outputs.diff_branch_pr_url }}"
+            echo "release_branch_pr_url: ${{ needs.copy-docs.outputs.release_branch_pr_url }}"
+
         - name: Only run in hashicorp/web-unified-docs-internal
           run: |
             if [ "${{ github.repository }}" != "hashicorp/web-unified-docs-internal" ]; then
@@ -53,7 +59,7 @@ jobs:
         - name: Checkout web-unified-docs repository
           uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
           with:
-            ref: '${{ needs.copy-docs.outputs.docs_branch_name }}'
+            ref: '${{ needs.copy-docs.outputs.release_branch_name }}'
 
         - name: Install and cache Ruby gems at root
           uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999 # v1.191.0
@@ -68,13 +74,14 @@ jobs:
 
         - name: Turn branch into PR
           run: |
-            PR_URL=$(scripts/tfe-releases/ci/create-pull-request.sh)
-            echo "PR_URL=$PR_URL" >> $GITHUB_ENV
+            export RELEASE_BRANCH_NAME="${{ needs.copy-docs.outputs.release_branch_name }}"
+            RELEASE_NOTES_PR_URL=$(scripts/tfe-releases/ci/create-pull-request.sh)
+            echo "RELEASE_NOTES_PR_URL=$RELEASE_NOTES_PR_URL" >> $GITHUB_ENV
 
         - name: Create PR URL
           if: ${{ env.DEV == 'false' }}
           run: |
-            echo "[TFE release notes PR for ${{ env.VERSION }}](${{ env.PR_URL }})" >> $GITHUB_STEP_SUMMARY
+            echo "[TFE release notes PR for ${{ env.VERSION }}](${{ env.RELEASE_NOTES_PR_URL }})" >> $GITHUB_STEP_SUMMARY
 
         - name: Slack notification
           id: slack
@@ -102,7 +109,7 @@ jobs:
                     "type": "section",
                     "text": {
                       "type": "mrkdwn",
-                      "text": "Please Review the PR - ${{ env.PR_URL }}"
+                      "text": "Please Review the PR - ${{ env.RELEASE_NOTES_PR_URL }}"
                     }
                   },
                   {
@@ -117,3 +124,30 @@ jobs:
                   }
                 ]
               }
+
+        - name: Update RELEASE PR with DIFF PR URL
+          env:
+            docs_pr_body: |
+              # TFE Release ${{env.VERSION}}
+
+              This PR was created via:
+              - ${{github.server_url}}/${{github.repository}}/actions/runs/${{github.run_id}}
+
+              Changes since last release, diff PR:
+              - ${{ needs.copy-docs.outputs.diff_branch_pr_url }}
+
+              Release Notes PR:
+              - ${{ needs.copy-docs.outputs.release_branch_pr_url }}
+
+
+              ❗ This is the Release PR that will be merged into main, once the release notes and diff PR are merged into it. ❗
+
+              ### Reviewers
+              - [ ] @hashicorp/ptfe-review
+              - [ ] @hashicorp/web-platform
+          run: |
+            git config --global user.email "team-rel-eng@hashicorp.com"
+            git config --global user.name "tfe-release-bot"
+
+            gh pr edit ${{ needs.copy-docs.outputs.release_branch_pr_url }} \
+              --body="${{env.docs_pr_body}}"
diff --git a/.ruby-version b/.ruby-version
@@ -1 +1 @@
-3.4.4
+3.3.5
diff --git a/scripts/tfe-releases/ci/create-pull-request.sh b/scripts/tfe-releases/ci/create-pull-request.sh
@@ -53,7 +53,9 @@ else
   pr_url="$(gh pr create \
     --body="$(cat pr_body.md)" \
     --title="$title" \
+    --base="${RELEASE_BRANCH_NAME}" \
     --draft)"
 
+
   echo $pr_url
 fi
