Merge branch 'main' into topograph #1928
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | |
| # SPDX-License-Identifier: Apache-2.0 | |
| # Workflow 1 of 2 for Fern doc previews. | |
| # | |
| # Collects fern/ sources and PR metadata and uploads them as an artifact. | |
| # No secrets are used here — safe to run on any push to a pull-request/* branch. | |
| # | |
| # The companion workflow (fern-docs-preview-comment.yml) picks up the artifact, | |
| # builds the preview with DOCS_FERN_TOKEN, and posts the PR comment. | |
| name: "Preview Fern Docs: Build" | |
| on: | |
| push: | |
| branches: | |
| - "pull-request/[0-9]+" | |
| permissions: | |
| contents: read | |
| jobs: | |
| changed-files: | |
| runs-on: linux-amd64-cpu32 | |
| outputs: | |
| docs: ${{ steps.changes.outputs.docs }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check for docs changes | |
| id: changes | |
| run: | | |
| if [ "${{ github.event.before }}" = "0000000000000000000000000000000000000000" ]; then | |
| echo "docs=true" >> $GITHUB_OUTPUT | |
| elif git diff --name-only "${{ github.event.before }}" HEAD 2>/dev/null | grep -qE '^(docs/|fern/)'; then | |
| echo "docs=true" >> $GITHUB_OUTPUT | |
| else | |
| echo "docs=false" >> $GITHUB_OUTPUT | |
| fi | |
| collect: | |
| needs: changed-files | |
| if: needs.changed-files.outputs.docs == 'true' | |
| runs-on: linux-amd64-cpu32 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| - name: Save PR metadata | |
| run: | | |
| PR_NUMBER="${GITHUB_REF#refs/heads/pull-request/}" | |
| HEAD_REF="${GITHUB_REF#refs/heads/}" | |
| mkdir -p preview-metadata | |
| echo "$PR_NUMBER" > preview-metadata/pr_number | |
| echo "$HEAD_REF" > preview-metadata/head_ref | |
| git diff --name-only "origin/main...HEAD" -- '*.md' > preview-metadata/changed_md_files 2>/dev/null || true | |
| - name: Checkout frozen version content | |
| run: | | |
| set -eo pipefail | |
| for version_file in fern/versions/v*.yml; do | |
| [ -f "$version_file" ] || continue | |
| version=$(basename "$version_file" .yml) | |
| if git show-ref --verify --quiet "refs/tags/${version}"; then | |
| mkdir -p "fern/versions/${version}-content" | |
| git archive "refs/tags/${version}" -- docs/ | tar -x --strip-components=1 -C "fern/versions/${version}-content" | |
| # Escape {, }, < for MDX — but only outside fenced code blocks and inline code spans | |
| find "fern/versions/${version}-content" -name '*.md' -print0 | while IFS= read -r -d '' f; do | |
| awk ' | |
| /^````*/ || /^~~~~*/ { fence = !fence; print; next } | |
| fence { print; next } | |
| { | |
| n = split($0, p, "`") | |
| out = "" | |
| for (i = 1; i <= n; i++) { | |
| if (i % 2 == 1) { | |
| gsub(/{/, "\\{", p[i]) | |
| gsub(/}/, "\\}", p[i]) | |
| gsub(/</, "\\<", p[i]) | |
| } | |
| out = out p[i] | |
| if (i < n) out = out "`" | |
| } | |
| print out | |
| } | |
| ' "$f" > "${f}.tmp" && mv "${f}.tmp" "$f" | |
| done | |
| echo "Extracted docs from $version" | |
| else | |
| echo "::warning::Tag $version not found — skipping content checkout" | |
| fi | |
| done | |
| - name: Upload fern sources and metadata | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: fern-preview | |
| path: | | |
| fern/ | |
| docs/ | |
| preview-metadata/ | |
| retention-days: 1 |