docs/.github/workflows/preview-docs.yml at 335e505ba115aa4dfc366df29dbc8b8a3f64f8a7 · doc-detective/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
name: Preview docs

on:
  pull_request:
    paths:
      - "fern/**"
  workflow_dispatch:

jobs:
  preview:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Check out repository
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2

      - name: Set up Fern CLI
        uses: fern-api/setup-fern-cli@d07601425e9c9ede8745d71ca75c4c462d98755d #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.*(?= \()')
          if [ -z "$URL" ]; then
            echo "preview_url=" >> "$GITHUB_OUTPUT"
            echo "⚠️ Failed to generate docs preview. Check the workflow logs for details." > preview_url.txt
          else
            echo "preview_url=$URL" >> "$GITHUB_OUTPUT"
            echo "🌿 Preview your docs: $URL" > preview_url.txt
          fi

      - name: Comment URL in PR
        if: github.event_name == 'pull_request'
        uses: thollander/actions-comment-pull-request@1d3973dc4b8e1399c0620d3f2b1aa5e795465308 #v2.4.3
        with:
          filePath: preview_url.txt
          comment_tag: preview-docs
          mode: upsert