0x-docs/.github/workflows/preview-docs.yml at e37d6a4aacf5ad2b81a087c8c2123a84cd2300e6 · 0xProject/0x-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
name: Preview Docs

on:
  pull_request:
    types: [opened, synchronize, ready_for_review]
    branches:
      - main

jobs:
  run:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      contents: read
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Fern CLI
        uses: fern-api/setup-fern-cli@v1

      - name: Generate preview URL
        id: generate-docs
        env:
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
        run: |
          OUTPUT=$(fern generate --docs --preview 2>&1) || true
          echo "$OUTPUT"
          URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()')
          echo "preview_url=$URL" >> $GITHUB_OUTPUT
          echo "Preview URL: $URL"

      - name: Get page links for changed MDX files
        id: page-links
        env:
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
        run: |
          PREVIEW_URL="${{ steps.generate-docs.outputs.preview_url }}"
          CHANGED_FILES=$(git diff --name-only origin/main...HEAD -- '*.mdx' 2>/dev/null || echo "")

          if [ -z "$CHANGED_FILES" ] || [ -z "$PREVIEW_URL" ]; then
            echo "page_links=" >> $GITHUB_OUTPUT; exit 0
          fi

          BASE_URL=$(echo "$PREVIEW_URL" | grep -oP 'https?://[^/]+')

          FILES_PARAM=$(echo "$CHANGED_FILES" | tr '\n' ',' | sed 's/,$//')
          RESPONSE=$(curl -sf -H "FERN_TOKEN: $FERN_TOKEN" "${PREVIEW_URL}/api/fern-docs/get-slug-for-file?files=${FILES_PARAM}" 2>/dev/null) || {
            echo "page_links=" >> $GITHUB_OUTPUT; exit 0
          }

          PAGE_LINKS=$(echo "$RESPONSE" | jq -r --arg url "$BASE_URL" \
            '.mappings[] | select(.slug != null) | "- [\(.slug)](\($url)/\(.slug))"')

          if [ -n "$PAGE_LINKS" ]; then
            { echo "page_links<<EOF"; echo "$PAGE_LINKS"; echo "EOF"; } >> $GITHUB_OUTPUT
          else
            echo "page_links=" >> $GITHUB_OUTPUT
          fi

      - name: Create comment content
        run: |
          echo ":herb: **Preview your docs:** <${{ steps.generate-docs.outputs.preview_url }}>" > comment.md

          if [ -n "${{ steps.page-links.outputs.page_links }}" ]; then
            echo "" >> comment.md
            echo "Here are the markdown pages you've updated:" >> comment.md
            echo "${{ steps.page-links.outputs.page_links }}" >> comment.md
          fi

      - name: Post PR comment
        uses: thollander/[email protected]
        with:
          filePath: comment.md
          comment_tag: preview-docs
          mode: upsert