nvcf/.github/workflows/fern-docs-preview-build.yml at main · NVIDIA/nvcf · 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
# 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.

# Workflow 1 of 2 for Fern doc previews.
#
# Collects the fern/ and docs/ sources plus PR metadata from the PR branch and
# uploads them as an artifact. Both directories are needed because
# fern/docs.yml references ../docs/index.yml; omitting docs/ causes
# `fern generate --docs` to fail in the companion workflow. No secrets are
# used here, so this is safe to run on fork PRs via the regular pull_request
# trigger.
#
# 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:
  pull_request:
    paths:
      - 'docs/**'
      - 'fern/**'
      - '.github/workflows/fern-docs-preview-build.yml'

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  collect:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Checkout PR
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Save PR metadata
        env:
          PR_NUMBER: ${{ github.event.pull_request.number }}
          HEAD_REF: ${{ github.head_ref }}
          BASE_REF: ${{ github.base_ref }}
        run: |
          mkdir -p preview-metadata
          echo "$PR_NUMBER" > preview-metadata/pr_number
          echo "$HEAD_REF" > preview-metadata/head_ref
          git diff --name-only "origin/${BASE_REF}...HEAD" -- '*.md' > preview-metadata/changed_md_files 2>/dev/null || true

      - 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