|
| 1 | +# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +# Workflow 2 of 2 for Fern doc previews. |
| 17 | +# |
| 18 | +# Triggered by workflow_run after "Preview Fern Docs: Build" completes. |
| 19 | +# Downloads the fern/ artifact, builds a preview with DOCS_FERN_TOKEN, and |
| 20 | +# posts a stable :herb: comment on the PR. This workflow never checks out the |
| 21 | +# PR branch directly, keeping secrets isolated from untrusted code. |
| 22 | +# |
| 23 | +# Required configuration: |
| 24 | +# - Organization secret: DOCS_FERN_TOKEN (from `fern token` for the nvidia Fern org) |
| 25 | + |
| 26 | +name: "Preview Fern Docs: Comment" |
| 27 | + |
| 28 | +on: |
| 29 | + workflow_run: |
| 30 | + workflows: ["Preview Fern Docs: Build"] |
| 31 | + types: [completed] |
| 32 | + |
| 33 | +permissions: |
| 34 | + pull-requests: write |
| 35 | + actions: read |
| 36 | + |
| 37 | +jobs: |
| 38 | + preview: |
| 39 | + runs-on: ubuntu-latest |
| 40 | + if: ${{ github.event.workflow_run.conclusion == 'success' }} |
| 41 | + steps: |
| 42 | + - name: Download fern sources and metadata |
| 43 | + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 |
| 44 | + with: |
| 45 | + name: fern-preview |
| 46 | + run-id: ${{ github.event.workflow_run.id }} |
| 47 | + github-token: ${{ secrets.GITHUB_TOKEN }} |
| 48 | + |
| 49 | + - name: Read PR metadata |
| 50 | + id: metadata |
| 51 | + run: | |
| 52 | + echo "pr_number=$(cat preview-metadata/pr_number)" >> "$GITHUB_OUTPUT" |
| 53 | + echo "head_ref=$(cat preview-metadata/head_ref)" >> "$GITHUB_OUTPUT" |
| 54 | +
|
| 55 | + - name: Setup Node.js |
| 56 | + uses: actions/setup-node@v6 |
| 57 | + with: |
| 58 | + node-version: '20' |
| 59 | + |
| 60 | + - name: Install Fern CLI |
| 61 | + run: npm install -g fern-api |
| 62 | + |
| 63 | + - name: Generate preview URL |
| 64 | + id: generate-docs |
| 65 | + env: |
| 66 | + FERN_TOKEN: ${{ secrets.DOCS_FERN_TOKEN }} |
| 67 | + HEAD_REF: ${{ steps.metadata.outputs.head_ref }} |
| 68 | + working-directory: ./fern |
| 69 | + run: | |
| 70 | + OUTPUT=$(fern generate --docs --preview --id "$HEAD_REF" 2>&1) |
| 71 | + echo "$OUTPUT" |
| 72 | + URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()') |
| 73 | + if [ -z "$URL" ]; then |
| 74 | + echo "::error::Failed to generate preview URL. See fern output above." |
| 75 | + exit 1 |
| 76 | + fi |
| 77 | + echo "preview_url=$URL" >> "$GITHUB_OUTPUT" |
| 78 | +
|
| 79 | + - name: Build page links for changed MDX files |
| 80 | + id: page-links |
| 81 | + env: |
| 82 | + FERN_TOKEN: ${{ secrets.DOCS_FERN_TOKEN }} |
| 83 | + PREVIEW_URL: ${{ steps.generate-docs.outputs.preview_url }} |
| 84 | + run: | |
| 85 | + CHANGED_FILES="" |
| 86 | + if [ -f preview-metadata/changed_mdx_files ]; then |
| 87 | + CHANGED_FILES=$(cat preview-metadata/changed_mdx_files) |
| 88 | + fi |
| 89 | +
|
| 90 | + if [ -z "$CHANGED_FILES" ] || [ -z "$PREVIEW_URL" ]; then |
| 91 | + echo "page_links=" >> "$GITHUB_OUTPUT"; exit 0 |
| 92 | + fi |
| 93 | +
|
| 94 | + BASE_URL=$(echo "$PREVIEW_URL" | grep -oP 'https?://[^/]+') |
| 95 | + FILES_PARAM=$(echo "$CHANGED_FILES" | tr '\n' ',' | sed 's/,$//' \ |
| 96 | + | python3 -c "import sys, urllib.parse; print(urllib.parse.quote(sys.stdin.read().strip(), safe=',/'))") |
| 97 | + RESPONSE=$(curl -sf -H "FERN_TOKEN: $FERN_TOKEN" "${PREVIEW_URL}/api/fern-docs/get-slug-for-file?files=${FILES_PARAM}" 2>/dev/null) || { |
| 98 | + echo "page_links=" >> "$GITHUB_OUTPUT"; exit 0 |
| 99 | + } |
| 100 | +
|
| 101 | + PAGE_LINKS=$(echo "$RESPONSE" | jq -r --arg url "$BASE_URL" \ |
| 102 | + '.mappings[] | select(.slug != null) | "- [\(.slug)](\($url)/\(.slug))"') |
| 103 | +
|
| 104 | + if [ -n "$PAGE_LINKS" ]; then |
| 105 | + { echo "page_links<<EOF"; echo "$PAGE_LINKS"; echo "EOF"; } >> "$GITHUB_OUTPUT" |
| 106 | + else |
| 107 | + echo "page_links=" >> "$GITHUB_OUTPUT" |
| 108 | + fi |
| 109 | +
|
| 110 | + - name: Post or update PR comment |
| 111 | + env: |
| 112 | + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 113 | + PR_NUMBER: ${{ steps.metadata.outputs.pr_number }} |
| 114 | + PREVIEW_URL: ${{ steps.generate-docs.outputs.preview_url }} |
| 115 | + PAGE_LINKS: ${{ steps.page-links.outputs.page_links }} |
| 116 | + run: | |
| 117 | + # Build comment body |
| 118 | + BODY=":herb: **Preview your docs:** <${PREVIEW_URL}>" |
| 119 | + if [ -n "${PAGE_LINKS}" ]; then |
| 120 | + BODY="${BODY} |
| 121 | +
|
| 122 | + Here are the markdown pages you've updated: |
| 123 | + ${PAGE_LINKS}" |
| 124 | + fi |
| 125 | +
|
| 126 | + # Hidden marker for upsert |
| 127 | + MARKER="<!-- preview-docs -->" |
| 128 | + BODY="${BODY} |
| 129 | +
|
| 130 | + ${MARKER}" |
| 131 | +
|
| 132 | + # Find existing comment with marker |
| 133 | + COMMENT_ID=$(gh api "repos/${{ github.repository }}/issues/${PR_NUMBER}/comments" \ |
| 134 | + --jq ".[] | select(.body | contains(\"${MARKER}\")) | .id" | tr -d '\r' | head -1) |
| 135 | +
|
| 136 | + if [ -n "$COMMENT_ID" ]; then |
| 137 | + gh api "repos/${{ github.repository }}/issues/comments/${COMMENT_ID}" \ |
| 138 | + -X PATCH -f body="$BODY" |
| 139 | + else |
| 140 | + gh api "repos/${{ github.repository }}/issues/${PR_NUMBER}/comments" \ |
| 141 | + -f body="$BODY" |
| 142 | + fi |
0 commit comments