fix: check links on preview (#2067)

* fix: check links on preview

* fix: update

* fix: preview only

* fix: log preview url

* fix: test

* fix: refactor

* fix: only run on docs changes

Author: Richard-Dang

.github/actions/preview-fern-docs/action.yml

@@ -0,0 +1,73 @@
+name: 'Generate Fern Docs Preview'
+description: 'Generates a Fern documentation preview and comments the URL in a PR'
+
+inputs:
+  github-token:
+    description: 'GitHub token for creating deployments and comments'
+    required: true
+  fern-token:
+    description: 'Fern API token for publishing docs'
+    required: true
+  ref:
+    description: 'Git ref to create deployment for (usually github.head_ref for PRs)'
+    required: true
+  environment:
+    description: 'Deployment environment name'
+    required: false
+    default: 'docs-preview'
+
+outputs:
+  preview-url:
+    description: 'The URL where the preview documentation was published'
+    value: ${{ steps.generate-preview.outputs.url }}
+  status:
+    description: 'The outcome of the preview generation (success, failure, etc.)'
+    value: ${{ steps.generate-preview.outcome }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Setup Docs
+      uses: ./.github/actions/setup-docs
+      with:
+        docs-github-token: ${{ inputs.github-token }}
+
+    - name: Set Build Comment to In Progress
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ inputs.github-token }}
+        script: |
+          const workspace = process.env.GITHUB_WORKSPACE;
+          const { updatePreviewComment } = await import(`${workspace}/docs-site/scripts/preview-comment.js`);
+
+          await updatePreviewComment({
+            github,
+            context,
+            status: 'building',
+          });
+
+    - name: Generate Fern Docs Preview
+      id: generate-preview
+      uses: ./.github/actions/publish-fern
+      with:
+        github-token: ${{ inputs.github-token }}
+        fern-token: ${{ inputs.fern-token }}
+        environment: ${{ inputs.environment }}
+        ref: ${{ inputs.ref }}
+        preview: "true"
+
+    - name: Comment Preview URL in PR
+      uses: actions/github-script@v7
+      if: always()
+      with:
+        github-token: ${{ inputs.github-token }}
+        script: |
+          const workspace = process.env.GITHUB_WORKSPACE;
+          const { updatePreviewComment } = await import(`${workspace}/docs-site/scripts/preview-comment.js`);
+
+          await updatePreviewComment({
+            github,
+            context,
+            previewUrl: '${{ steps.generate-preview.outputs.url }}',
+            status: '${{ steps.generate-preview.outcome }}',
+          });

.github/workflows/on-pull-request.yml

@@ -36,6 +36,27 @@ jobs:
         env:
           TITLE: ${{ github.event.pull_request.title }}
         run: echo "$TITLE" | yarn commitlint
+  
+  preview:
+    name: Generate Documentation Preview
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+      pull-requests: write
+    outputs:
+      preview-url: ${{ steps.preview.outputs.preview-url }}
+    steps:
+      - name: Checkout aa-sdk
+        uses: actions/checkout@v4
+
+      - name: Generate Documentation Preview
+        id: preview
+        uses: ./.github/actions/preview-fern-docs
+        with:
+          github-token: ${{ github.token }}
+          fern-token: ${{ secrets.FERN_TOKEN }}
+          ref: ${{ github.head_ref }}
 
   lint_docs:
     name: Lint Documentation
@@ -72,10 +93,8 @@ jobs:
   check_broken_links:
     name: Check Broken Links
     runs-on: ubuntu-latest
-    needs: changes
-    if: ${{ needs.changes.outputs.docs == 'true' }}
-    # TODO: Remove this after fixing all broken links
-    continue-on-error: true
+    needs: [changes, preview]
+    if: ${{ needs.changes.outputs.docs == 'true' && needs.preview.outputs.preview-url != '' }}
     steps:
       - name: "Checkout files"
         uses: actions/checkout@v3
@@ -101,7 +120,7 @@ jobs:
           lychee --version
 
       - name: Check for broken links
-        run: yarn docs:broken-links
+        run: yarn docs:broken-links --base-url "${{ needs.preview.outputs.preview-url }}"
 
   lint:
     name: Lint