Repository navigation
fix(ci): validate repository links against the PR tree #299
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-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | |
| # SPDX-License-Identifier: Apache-2.0 | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: Preview Fern Docs | |
| on: | |
| push: | |
| branches: | |
| - "pull-request/[0-9]+" | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| FERN_NO_VERSION_REDIRECTION: "true" | |
| jobs: | |
| changed-files: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| outputs: | |
| docs: ${{ steps.changed-files.outputs.docs_any_changed }} | |
| steps: | |
| - name: Checkout approved PR mirror | |
| uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Get PR info | |
| id: get-pr-info | |
| uses: nv-gha-runners/get-pr-info@090577647b8ddc4e06e809e264f7881650ecdccf # main | |
| - name: Get changed files | |
| id: changed-files | |
| uses: step-security/changed-files@2e07db73e5ccdb319b9a6c7766bd46d39d304bad # v47.0.5 | |
| with: | |
| base_sha: ${{ fromJSON(steps.get-pr-info.outputs.pr-info).base.sha }} | |
| sha: ${{ github.sha }} | |
| files_yaml: | | |
| docs: | |
| - docs/** | |
| - skills/** | |
| - .github/workflows/fern-docs-ci.yml | |
| - .github/workflows/fern-docs-preview.yml | |
| - name: Report docs preview gate | |
| env: | |
| DOCS_CHANGED: ${{ steps.changed-files.outputs.docs_any_changed }} | |
| run: | | |
| printf 'Docs or preview workflow changed: %s\n' "$DOCS_CHANGED" | tee -a "$GITHUB_STEP_SUMMARY" | |
| preview: | |
| needs: changed-files | |
| # An approved upstream mirror is the trust boundary, even for a fork PR. | |
| # The original PR head repository does not change when its commit is mirrored. | |
| if: >- | |
| github.repository == 'NVIDIA-NeMo/Megatron-Bridge' && | |
| needs.changed-files.outputs.docs == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| steps: | |
| - name: Verify current PR against mirror push | |
| id: pr | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| set -euo pipefail | |
| [[ "$GITHUB_REF" =~ ^refs/heads/pull-request/([1-9][0-9]*)$ ]] | |
| PR_NUMBER=${BASH_REMATCH[1]} | |
| gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER" | jq -e \ | |
| --arg repo "$GITHUB_REPOSITORY" --arg sha "$GITHUB_SHA" --argjson number "$PR_NUMBER" \ | |
| '.number == $number and .state == "open" and .head.sha == $sha and | |
| .base.repo.full_name == $repo' | |
| echo "number=$PR_NUMBER" >> "$GITHUB_OUTPUT" | |
| - name: Checkout trusted configuration | |
| uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 | |
| with: | |
| ref: main | |
| path: trusted-source | |
| persist-credentials: false | |
| - name: Checkout approved PR content | |
| uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 | |
| with: | |
| ref: ${{ github.sha }} | |
| path: pr-source | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Prepare preview docs | |
| run: | | |
| set -euo pipefail | |
| mkdir -p "$RUNNER_TEMP/fern-preview" | |
| CONTENT='.*\.(md|mdx|png|jpg|jpeg|gif|svg|webp|ico|pdf)' | |
| for ROOT in docs/fern skills; do | |
| test -d "pr-source/$ROOT" | |
| test -z "$(find "pr-source/$ROOT" -type l -print -quit)" | |
| mkdir -p "$RUNNER_TEMP/fern-preview/$(dirname "$ROOT")" | |
| cp -R "trusted-source/$ROOT" "$RUNNER_TEMP/fern-preview/$ROOT" | |
| # Keep newer main pages as fallbacks, but honor explicit PR deletions. | |
| BASE=$(git -C pr-source merge-base HEAD refs/remotes/origin/main) | |
| git -C pr-source diff --no-renames --diff-filter=D --name-only -z \ | |
| "$BASE" HEAD -- "$ROOT/" > "$RUNNER_TEMP/fern-deleted-paths" | |
| while IFS= read -r -d '' path; do | |
| case "$path" in | |
| */.*|*/components/*) continue ;; | |
| esac | |
| case "$path" in | |
| *.md|*.mdx|*.png|*.jpg|*.jpeg|*.gif|*.svg|*.webp|*.ico|*.pdf) | |
| rm -f -- "$RUNNER_TEMP/fern-preview/$path" ;; | |
| esac | |
| done < "$RUNNER_TEMP/fern-deleted-paths" | |
| # Navigation, components and tooling stay on the trusted branch. | |
| (cd pr-source && find "$ROOT" -regextype posix-extended -type f \ | |
| -regex "$CONTENT" ! -path '*/.*' ! -path '*/components/*' \ | |
| -exec cp --parents -- '{}' "$RUNNER_TEMP/fern-preview/" \;) | |
| done | |
| printf '%s\n' '{"organization":"nvidia","version":"5.40.0"}' \ | |
| > "$RUNNER_TEMP/fern-preview/docs/fern/fern.config.json" | |
| - name: Setup Node.js | |
| uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 | |
| with: | |
| node-version: '20' | |
| - name: Install fixed Fern CLI | |
| working-directory: ${{ runner.temp }} | |
| run: npm install --prefix "$RUNNER_TEMP/fern-cli" --ignore-scripts --no-audit --no-fund fern-api@5.40.0 | |
| - name: Generate preview | |
| env: | |
| FERN_TOKEN: ${{ secrets.DOCS_FERN_TOKEN }} | |
| PR_NUMBER: ${{ steps.pr.outputs.number }} | |
| working-directory: ${{ runner.temp }}/fern-preview/docs/fern | |
| run: | | |
| set -euo pipefail | |
| "$RUNNER_TEMP/fern-cli/node_modules/.bin/fern" generate --docs --preview \ | |
| --id "pr-${PR_NUMBER}-${GITHUB_SHA:0:12}" 2>&1 | tee "$RUNNER_TEMP/fern-preview.log" | |
| - name: Read preview URL without credentials | |
| id: preview | |
| env: | |
| PR_NUMBER: ${{ steps.pr.outputs.number }} | |
| run: | | |
| set -euo pipefail | |
| URL=$(sed -n 's/^.*Published docs to \(https:\/\/[^ ]*\) (.*/\1/p' "$RUNNER_TEMP/fern-preview.log") | |
| HOST="nvidia-preview-pr-${PR_NUMBER}-${GITHUB_SHA:0:12}.docs.buildwithfern.com" | |
| [[ "$URL" == "https://$HOST" || "$URL" == "https://$HOST/"* ]] | |
| PATH_PART=${URL#"https://$HOST"} | |
| [[ "$PATH_PART" =~ ^(/[a-zA-Z0-9/_-]*)?$ ]] | |
| echo "url=$URL" >> "$GITHUB_OUTPUT" | |
| - name: Post or update preview comment | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| PR_NUMBER: ${{ steps.pr.outputs.number }} | |
| PREVIEW_URL: ${{ steps.preview.outputs.url }} | |
| run: | | |
| set -euo pipefail | |
| gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER" | jq -e \ | |
| --arg sha "$GITHUB_SHA" '.state == "open" and .head.sha == $sha' | |
| BODY=$(printf ':herb: **Preview your docs:** <%s>\n\n<!-- preview-docs -->' "$PREVIEW_URL") | |
| COMMENT_ID=$(gh api --paginate "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments" \ | |
| --jq '.[] | select(.user.login == "github-actions[bot]" and (.body | contains("<!-- preview-docs -->"))) | .id' | head -1) | |
| if [ -n "$COMMENT_ID" ]; then | |
| gh api "repos/$GITHUB_REPOSITORY/issues/comments/$COMMENT_ID" -X PATCH -f body="$BODY" | |
| else | |
| gh api "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments" -f body="$BODY" | |
| fi | |
| clear-preview: | |
| needs: changed-files | |
| if: >- | |
| github.repository == 'NVIDIA-NeMo/Megatron-Bridge' && | |
| needs.changed-files.outputs.docs == 'false' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: write | |
| steps: | |
| - name: Remove stale preview comments after docs changes are reverted | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| set -euo pipefail | |
| [[ "$GITHUB_REF" =~ ^refs/heads/pull-request/([1-9][0-9]*)$ ]] | |
| PR_NUMBER=${BASH_REMATCH[1]} | |
| gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER" | jq -e \ | |
| --arg repo "$GITHUB_REPOSITORY" --arg sha "$GITHUB_SHA" --argjson number "$PR_NUMBER" \ | |
| '.number == $number and .state == "open" and .head.sha == $sha and | |
| .base.repo.full_name == $repo' | |
| gh api --paginate "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments" \ | |
| --jq '.[] | select(.user.login == "github-actions[bot]" and (.body | contains("<!-- preview-docs -->"))) | .id' \ | |
| > "$RUNNER_TEMP/fern-preview-comments" | |
| while IFS= read -r comment; do | |
| [[ "$comment" =~ ^[1-9][0-9]*$ ]] | |
| gh api "repos/$GITHUB_REPOSITORY/issues/comments/$comment" -X DELETE | |
| done < "$RUNNER_TEMP/fern-preview-comments" |