Preview changes

1
name: Preview Docs
2
3
on:
4
  pull_request_target:
5
    types: [opened, synchronize, ready_for_review]
6
    branches:
7
      - main
8
9
jobs:
10
  run:
11
    runs-on: ubuntu-latest
12
    permissions:
13
      pull-requests: write
14
      contents: read
15
    steps:
16
      - name: Checkout repository
17
        uses: actions/checkout@v4
18
        with:
19
          fetch-depth: 0
20
21
      - name: Checkout PR
22
        run: |
23
          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr-${{ github.event.pull_request.number }}
24
          git checkout pr-${{ github.event.pull_request.number }}
25
26
      - name: Setup Fern CLI
27
        uses: fern-api/setup-fern-cli@v1
28
29
      - name: Generate preview URL
30
        id: generate-docs
31
        env:
32
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
33
        run: |
34
          OUTPUT=$(fern generate --docs --preview 2>&1) || true
35
          echo "$OUTPUT"
36
          URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()')
37
          echo "preview_url=$URL" >> $GITHUB_OUTPUT
38
          echo "Preview URL: $URL"
39
40
      - name: Get page links for changed MDX files
41
        id: page-links
42
        env:
43
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
44
        run: |
45
          PREVIEW_URL="${{ steps.generate-docs.outputs.preview_url }}"
46
          CHANGED_FILES=$(git diff --name-only origin/main...HEAD -- '*.mdx' 2>/dev/null || echo "")
47
48
          if [ -z "$CHANGED_FILES" ] || [ -z "$PREVIEW_URL" ]; then
49
            echo "page_links=" >> $GITHUB_OUTPUT; exit 0
50
          fi
51
52
          BASE_URL=$(echo "$PREVIEW_URL" | grep -oP 'https?://[^/]+')
53
54
          FILES_PARAM=$(echo "$CHANGED_FILES" | tr '\n' ',' | sed 's/,$//')
55
          RESPONSE=$(curl -sf -H "FERN_TOKEN: $FERN_TOKEN" "${PREVIEW_URL}/api/fern-docs/get-slug-for-file?files=${FILES_PARAM}" 2>/dev/null) || {
56
            echo "page_links=" >> $GITHUB_OUTPUT; exit 0
57
          }
58
59
          PAGE_LINKS=$(echo "$RESPONSE" | jq -r --arg url "$BASE_URL" \
60
            '.mappings[] | select(.slug != null) | "- [\(.slug)](\($url)/\(.slug))"')
61
62
          if [ -n "$PAGE_LINKS" ]; then
63
            { echo "page_links<<EOF"; echo "$PAGE_LINKS"; echo "EOF"; } >> $GITHUB_OUTPUT
64
          else
65
            echo "page_links=" >> $GITHUB_OUTPUT
66
          fi
67
68
      - name: Create comment content
69
        run: |
70
          echo ":herb: **Preview your docs:** <${{ steps.generate-docs.outputs.preview_url }}>" > comment.md
71
72
          if [ -n "${{ steps.page-links.outputs.page_links }}" ]; then
73
            echo "" >> comment.md
74
            echo "Here are the markdown pages you've updated:" >> comment.md
75
            echo "${{ steps.page-links.outputs.page_links }}" >> comment.md
76
          fi
77
78
      - name: Post PR comment
79
        uses: thollander/actions-comment-pull-request@v2.4.3
80
        with:
81
          filePath: comment.md
82
          comment_tag: preview-docs
83
          mode: upsert