OpenShell/.github/workflows/sync-docs.yml at pull-request/3012 · NVIDIA/OpenShell · GitHub

View runs

History

253 lines (237 loc) · 8.26 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

# SPDX-License-Identifier: Apache-2.0

name: Sync Docs Website

on:

workflow_call:

inputs:

operation:

description: "Whether to sync or remove a docs snapshot"

required: true

type: string

channel:

description: "Docs channel to update or remove"

required: true

type: string

source_ref:

description: "Source commit SHA, branch, or tag to snapshot when operation=sync"

required: false

type: string

release_version:

description: "Release version used to order mutable channels"

required: false

type: string

version_slug:

description: "Version slug when channel=version"

required: false

type: string

display_name:

description: "Optional version selector display name"

required: false

type: string

availability:

description: "Optional Fern availability status"

required: false

type: string

publish:

description: "Publish production docs after syncing"

required: false

default: false

type: boolean

allow_rollback:

description: "Allow an explicitly requested mutable-channel rollback"

required: false

default: false

type: boolean

secrets:

FERN_TOKEN:

required: false

workflow_dispatch:

inputs:

operation:

description: "Whether to sync or remove a docs snapshot"

required: true

default: sync

type: choice

options:

- sync

- remove

channel:

description: "Docs channel to update or remove"

required: true

type: choice

options:

- dev

- latest

- stable

- version

source_ref:

description: "Source commit SHA, branch, or tag to snapshot when operation=sync"

required: false

type: string

release_version:

description: "Release version, e.g. 0.1.2 or 0.1.3.dev4"

required: false

type: string

version_slug:

description: "Version slug when channel=version, e.g. v0.0.36"

required: false

type: string

display_name:

description: "Optional selector name, e.g. Dev"

required: false

type: string

availability:

description: "Optional Fern status: beta, deprecated, ga, or stable"

required: false

type: string

publish:

description: "Publish production docs after syncing"

required: false

default: false

type: boolean

allow_rollback:

description: "Allow an explicitly requested mutable-channel rollback"

required: false

default: false

type: boolean

permissions:

contents: write

concurrency:

group: docs-website

cancel-in-progress: false

queue: max

defaults:

run:

shell: bash

jobs:

sync:

runs-on: ubuntu-latest

timeout-minutes: 20

steps:

- name: Checkout automation

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

path: automation

- name: Validate inputs

# Pass dispatch inputs through env vars rather than interpolating

# ${{ inputs.* }} directly into the script. source_ref/version_slug are

# free-form strings, so inlining them would allow shell injection into

# the runner (e.g. version_slug = "$(...)"). Quoted env vars are inert.

env:

OPERATION: ${{ inputs.operation }}

CHANNEL: ${{ inputs.channel }}

SOURCE_REF: ${{ inputs.source_ref }}

RELEASE_VERSION: ${{ inputs.release_version }}

VERSION_SLUG: ${{ inputs.version_slug }}

run: |

set -euo pipefail

if [[ "$OPERATION" == "sync" && -z "$SOURCE_REF" ]]; then

echo "source_ref is required when operation=sync" >&2

exit 1

if [[ "$CHANNEL" =~ ^(dev|latest|stable)$ && -z "$RELEASE_VERSION" ]]; then

echo "release_version is required for dev, latest, and stable channels" >&2

exit 1

if [[ "$CHANNEL" =~ ^(stable|version)$ && -z "$VERSION_SLUG" ]]; then

echo "version_slug is required for stable and version channels" >&2

exit 1

- name: Checkout source docs

if: ${{ inputs.operation == 'sync' }}

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

ref: ${{ inputs.source_ref }}

fetch-depth: 0

path: source

- name: Checkout docs website branch

uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

ref: docs-website

fetch-depth: 0

path: docs-website

- name: Install uv

uses: astral-sh/setup-uv@ae62891fec2bb8e7d6c99fc78c9fec3a63790f8d # v10.0.0

with:

version: "0.10.12"

python-version: "3.13"

- name: Update docs snapshot

# Inputs flow in as quoted env vars to avoid shell injection; see the

# Validate inputs step above.

env:

OPERATION: ${{ inputs.operation }}

CHANNEL: ${{ inputs.channel }}

SOURCE_REF: ${{ inputs.source_ref }}

RELEASE_VERSION: ${{ inputs.release_version }}

VERSION_SLUG: ${{ inputs.version_slug }}

DISPLAY_NAME: ${{ inputs.display_name }}

AVAILABILITY: ${{ inputs.availability }}

ALLOW_ROLLBACK: ${{ inputs.allow_rollback }}

run: |

SOURCE_SHA=""

if [[ "$OPERATION" == "sync" ]]; then

SOURCE_SHA=$(git -C source rev-parse HEAD)

rollback_args=()

if [[ "$ALLOW_ROLLBACK" == "true" ]]; then

rollback_args+=(--allow-rollback)

uv run automation/tasks/scripts/sync_docs_website.py \

--operation "$OPERATION" \

--source-root source \

--docs-website-root docs-website \

--channel "$CHANNEL" \

--source-ref "$SOURCE_REF" \

--source-sha "$SOURCE_SHA" \

--release-version "$RELEASE_VERSION" \

--version-slug "$VERSION_SLUG" \

--display-name "$DISPLAY_NAME" \

--availability "$AVAILABILITY" \

"${rollback_args[@]}"

- name: Setup Node.js

uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0

with:

node-version: "24"

- name: Install Fern CLI

working-directory: docs-website

run: |

FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")

npm install -g "fern-api@${FERN_VERSION}"

- name: Validate docs website

working-directory: docs-website/fern

run: fern check

- name: Commit docs website changes

working-directory: docs-website

# Inputs flow in as quoted env vars to avoid shell injection (the commit

# message embeds free-form source_ref/version_slug); see Validate inputs.

env:

OPERATION: ${{ inputs.operation }}

CHANNEL: ${{ inputs.channel }}

SOURCE_REF: ${{ inputs.source_ref }}

VERSION_SLUG: ${{ inputs.version_slug }}

run: |

set -euo pipefail

git config user.name "github-actions[bot]"

# https://api.github.com/users/github-actions%5Bbot%5D

git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

git add .

if git diff --cached --quiet; then

echo "No docs website changes to commit."

exit 0

target="$VERSION_SLUG"

if [[ -z "${target}" ]]; then

target="$CHANNEL"

if [[ "$OPERATION" == "sync" ]]; then

git commit -m "docs(website): sync ${target} docs from ${SOURCE_REF}"

else

git commit -m "docs(website): remove ${target} docs"

git push origin HEAD:docs-website

- name: Publish Fern docs

if: ${{ inputs.publish }}

env:

FERN_TOKEN: ${{ secrets.FERN_TOKEN }}

working-directory: docs-website/fern

run: fern generate --docs

OpenShell/.github/workflows/sync-docs.yml at pull-request/3012 · NVIDIA/OpenShell · GitHub

Uh oh!

Expand file tree

Breadcrumbs

sync-docs.yml

Latest commit

History

Breadcrumbs

sync-docs.yml

File metadata and controls