OpenShell/.github/workflows/publish-docs-website.yml at main · dkaygithub/OpenShell · 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

name: Publish Docs Website

on:
  workflow_dispatch:
    inputs:
      mode:
        description: "Fern publish mode"
        required: true
        default: preview
        type: choice
        options:
          - preview
          - production
      preview_id:
        description: "Optional Fern preview id when mode=preview"
        required: false
        type: string

permissions:
  contents: read

concurrency:
  group: docs-website
  cancel-in-progress: false

defaults:
  run:
    shell: bash

jobs:
  publish:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - name: Checkout docs website branch
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
        with:
          ref: docs-website

      - name: Setup Node.js
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
        with:
          node-version: "24"

      - name: Install Fern CLI
        run: |
          FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
          npm install -g "fern-api@${FERN_VERSION}"

      - name: Validate docs website
        working-directory: ./fern
        run: fern check

      - name: Generate Fern preview
        if: ${{ inputs.mode == 'preview' }}
        env:
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
          INPUT_PREVIEW_ID: ${{ inputs.preview_id }}
        working-directory: ./fern
        run: |
          set -euo pipefail
          PREVIEW_ID="${INPUT_PREVIEW_ID:-docs-website-${{ github.run_id }}}"
          fern generate --docs --preview --id "$PREVIEW_ID"

      - name: Publish Fern docs
        if: ${{ inputs.mode == 'production' }}
        env:
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
        working-directory: ./fern
        run: fern generate --docs