Skip to content

ci: Include OpenAPI spec in Fern preview artifact #1946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kfelternv wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −1
Draft

ci: Include OpenAPI spec in Fern preview artifact #1946

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/fern-docs-preview-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@

# Workflow 1 of 2 for Fern doc previews.
#
# Collects fern/, docs/, and PR metadata and uploads an artifact.
# Collects fern/, docs/, rest-api/openapi/, and PR metadata and uploads an
# artifact. fern/generators.yml references ../rest-api/openapi/spec.yaml,
# so the OpenAPI spec must travel with the artifact for the companion
# workflow's `fern generate` to resolve the API definition.
#
# The companion workflow (fern-docs-preview-comment.yml) runs after this one;
# it skips cleanly when no artifact exists (e.g. skipped fork pull_request).
Expand All @@ -27,13 +30,15 @@ on:
paths:
- 'fern/**'
- 'docs/**'
- 'rest-api/openapi/**'
- '.github/workflows/fern-docs-preview-build.yml'
push:
branches:
- 'pull-request/[0-9]+'
paths:
- 'fern/**'
- 'docs/**'
- 'rest-api/openapi/**'
- '.github/workflows/fern-docs-preview-build.yml'

permissions:
Expand Down Expand Up @@ -76,5 +81,6 @@ jobs:
path: |
fern/
docs/
rest-api/openapi/
preview-metadata/
retention-days: 1