-
Notifications
You must be signed in to change notification settings - Fork 7
Update self-hosted changelog: v0.114.86 #5446
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.
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
base: main
Are you sure you want to change the base?
Changes from 19 commits
6fe60cd
16410ca
4914d57
bcad8c7
34839f7
2bb9258
f516a31
69867e4
f0a082b
981ca1f
b0b548d
fb7d1e1
fb7e22a
d44c4b9
250a73e
7534186
c91113b
9676969
a5b09c5
d558c7e
b59a7ba
d558a34
7095515
5adb4ff
5aa4766
ce7e56d
b102364
82b7035
81fe7fe
88749c1
72dd460
881f408
ed1274b
876280a
cb9e8f2
6abd5c6
cf1be84
7f053b0
6b0a66f
699107a
d216354
04549e6
c636fbe
d3e80b5
e8b7138
f84fecd
135a255
a82c481
5af1a60
069bd8f
5416daa
ca5526e
4d1670f
9170f05
d94403e
6d7b154
87333d3
5c40f51
fdd8683
5764258
37499bb
507573f
bd800b9
e2b70e0
6170a33
f82ef0d
624ae7c
161ca65
33750c5
e168bf6
d6e0220
0aeaf19
b513444
40a2f96
7afb607
07e0f7b
f554ba0
d11ccd8
be0f279
bf327a7
870932f
89f641f
317941e
ebc6639
686fcfe
ef19f6b
126c522
ba5f179
4666f88
af9e33a
0a4839b
0ce1d0b
c0d25cf
9fc6c3f
9056819
ed13666
852b5c2
d1b4f66
3de7b2a
234a9f4
e16e880
9b03d87
25c0557
89ac5a6
d4ab9a2
3d90ba1
da6e885
8dd604a
c8aba3a
21855e5
422cade
c6974c4
2831b81
1739ff3
f00d2ab
55fe9f6
f688940
fa53518
0848a5c
0615705
52f2176
926ee96
b313a40
0994cf8
2cbd733
db54af6
8d6dc55
93a8e49
a0ddbd0
e60c9c4
45ebc81
0ceaa5a
489cc98
c87b5a0
5a165b9
146aa36
0e4773a
fdee688
7e1f171
6336ac4
70d8105
537771e
474df3f
83800e2
f317b70
064ebe3
8395d62
e34acdf
74ee796
1db16a1
a255194
49c5059
0ce3936
3791855
a10f7b8
6362cd5
309d114
25db50e
ee0088d
24e6f2b
c81d190
f4cc927
6c355e2
a7d33c3
41feae1
1c77f7e
b2b64fa
b4305d7
7599f1f
a5583b3
95425f7
26e491a
689c4e3
74a290c
052909e
811d2ed
08edbf3
134b2e1
22d6b2a
e41e678
03b4022
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ## 5.22.0 | ||
| **`(feat):`** Add `fern sdk list` command to list configured and available SDK generators. | ||
| Displays configured SDKs from local fern.yml and available generators from the | ||
| Fern registry. Supports `--language`, `--type`, and `--json` flags. | ||
|
|
||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| ## 5.23.1 | ||
| **`(fix):`** Fix `fern docs dev` hanging indefinitely on Node.js v26+ on Linux by disabling | ||
| io_uring in the child server process. Node 26 enables io_uring by default in | ||
| libuv, which has a busy-loop bug where worker threads spin on an internal | ||
| eventfd, starving the main event loop. | ||
|
|
||
|
|
||
| ## 5.23.0 | ||
| **`(internal):`** Add an opt-in `VerificationStep` to the post-generation pipeline that runs | ||
| `.fern/verify.sh` (when emitted by the generator) inside a language-specific | ||
| `{generatorImage}-validator` container after replay and before any GitHub | ||
| push. A failing script aborts the pipeline before opening a PR and surfaces | ||
| raw stderr through the pipeline logger; a missing script is a silent no-op. | ||
|
|
||
| The step is gated on a hidden `--verify` flag for `fern generate`; when | ||
| passed (with `--local` or `--runner`), the local workspace runner sets | ||
| `config.verify.enabled = true` on the pipeline and the configured container | ||
| runtime (`docker` or `podman`) is forwarded to the validator container. | ||
| Remote/Fiddle generation does not honor this flag yet. | ||
|
|
||
|
|
||
| ## 5.22.1 | ||
| **`(fix):`** Fix `fern docs dev` failing with pnpm 11 due to esbuild build scripts being blocked by default. | ||
| Writes `onlyBuiltDependencies` config to the bundle folder before installing esbuild. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,9 @@ description: Generate MDX documentation pages from your Python or C++ library so | |
| --- | ||
|
|
||
|
|
||
| The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages include cross-reference links and hierarchical navigation, and are integrated directly into your Fern Docs site. | ||
| The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages are added to your Fern Docs site with hierarchical navigation. | ||
|
|
||
| Cross-links are automatic. When a fully-qualified identifier appears in a code block — for example, in a class signature or type annotation — the generator links it to the page documenting that symbol, so readers can jump straight to the definition. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ## Configuration | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -147,7 +147,7 @@ This guide covers the CLI path. A browser-based guided setup also exists at http | |
| </Step> | ||
| <Step title="Customize your docs"> | ||
|
|
||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or finetuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) | ||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or fine-tuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| <AccordionGroup toc={true}> | ||
| <Accordion title='Add content' > | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ Fern offers two ways to preview documentation changes: | |
| Install the following: | ||
| - Node.js version 22 or higher | ||
| - [The Fern CLI](/learn/cli-api-reference/cli-reference/overview#install-fern-cli) | ||
| - [pnpm](https://pnpm.io/installation), available on your `PATH`. `fern docs dev` uses pnpm internally to install the dependencies it needs to render your preview (for example, `esbuild`), so it must be installed globally even if your project uses npm or yarn. | ||
| </Info> | ||
|
|
||
| ## Local development | ||
|
|
@@ -55,6 +56,12 @@ Some features are disabled in local development: | |
|
|
||
| `fern docs dev` and `fern generate --docs` must be run from a directory that contains a [`fern/` folder](/learn/docs/getting-started/project-structure) with a `docs.yml` inside. Change into your project directory, or add a `docs.yml`. | ||
|
|
||
| #### Failed to install required package due to error: Command failed with exit code 1: pnpm i esbuild | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| `fern docs dev` shells out to pnpm to install the dependencies it needs to render your preview. Install [pnpm](https://pnpm.io/installation) globally and make sure it's on your `PATH`, then rerun `fern docs dev`. Your project's package manager (npm, yarn, etc.) doesn't need to change. | ||
|
|
||
| If the same command also prints `[ERR_PNPM_IGNORED_BUILDS] Ignored build scripts: esbuild`, run `pnpm approve-builds` and approve `esbuild` so pnpm allows its post-install scripts to run. | ||
|
|
||
| #### Broken link to /some/path (resolved path: ...) | ||
|
|
||
| `fern check` reports this when a link in a Markdown page doesn't resolve to a real page, anchor, or file in your docs. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| ### v0.114.44 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.44 | ||
| ``` | ||
|
|
||
| Digest: `sha256:1af81539eb27cd3c8f5e049581ca48f49388dbbee5a87bdafc30dd3ea8096d6e` | ||
|
|
||
| ### v0.114.44 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.44 | ||
| ``` | ||
|
|
||
| Digest: `sha256:1af81539eb27cd3c8f5e049581ca48f49388dbbee5a87bdafc30dd3ea8096d6e` | ||
|
|
||
| ### v0.114.45 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.45 | ||
| ``` | ||
|
|
||
| Digest: `sha256:402c90cc3b4f043b461a840901f192e1a71ffb06b573e2760b1aa5a5ebff8292` | ||
|
|
||
| ### v0.114.45 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.45 | ||
| ``` | ||
|
|
||
| Digest: `sha256:402c90cc3b4f043b461a840901f192e1a71ffb06b573e2760b1aa5a5ebff8292` | ||
|
|
||
| ### v0.114.46 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.46 | ||
| ``` | ||
|
|
||
| Digest: `sha256:c7aa2e5b00f764469d5310beca727cf29a21694f831bdbb6c34aa9472c44c295` | ||
|
|
||
| ### v0.114.46 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.46 | ||
| ``` | ||
|
|
||
| Digest: `sha256:c7aa2e5b00f764469d5310beca727cf29a21694f831bdbb6c34aa9472c44c295` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ### v0.114.47 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.47 | ||
| ``` | ||
|
|
||
| Digest: `sha256:23b4cb7e2dc2ccf93a10f1e1ab69247c74b01df4bae211c2268d077cc94922c8` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| ## 2.66.1 | ||
| **`(chore):`** Bump the C# SDK and C# model generator containers' Node base image from | ||
| `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the generators | ||
| with the rest of the Fern generator containers on a single Node major | ||
| version (Node 24) and picks up Node 24's CVE patches. The bundled npm | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
| 11.12.1 in `node:24.15` already ships patched `brace-expansion@5.0.4`, so | ||
| the C# SDK's `brace-expansion 2.0.3` replacement step is removed. The | ||
| `ip-address` and `picomatch` patches are retained because the bundled | ||
| versions in `node:24.15` (10.1.0 and 4.0.3 respectively) are still | ||
| vulnerable. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ## 1.41.0 | ||
| **`(feat):`** Add a `With<AuthToken>Func` option for bearer auth that accepts a `func() (string, error)` callable. | ||
| The callable is evaluated at request time when no static token is set, matching the callable | ||
| auth behavior available in the Python and TypeScript SDK generators. | ||
|
|
||
|
|
||
| ## 1.40.4 | ||
| **`(chore):`** Bump the Go SDK and Go model generator containers' Node base image from | ||
| `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the generators | ||
| with the rest of the Fern generator containers on a single Node major | ||
| version (Node 24) and picks up Node 24's CVE patches. The existing | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
| `npm pack <pkg>@latest` loop that swaps in patched `ip-address`, | ||
| `brace-expansion`, and `picomatch` is retained because `npm pack @latest` | ||
| continues to resolve the same fixed releases on Node 24. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ## 4.8.5 | ||
| **`(chore):`** Bump the Java SDK generator container's Node base image from | ||
| `node:24.14.1-bookworm` to `node:24.15-trixie`. Aligns the generator | ||
| with the rest of the Fern generator containers on a single Node patch | ||
| minor (floating `24.15`) and a single Debian release (trixie). Trixie ships | ||
| patched versions of glibc, dpkg, nghttp2, libcap2, systemd, libgcrypt20, | ||
| krb5, curl, and expat that are not available on bookworm, clearing the | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
| AWS Inspector findings that dist-upgrade alone could not. The non-slim | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
| variant is intentional because the Node-stage patch steps shell out to | ||
| `curl` and `tar`. The bundled npm 11.12.1 in `node:24.15` already ships | ||
| patched `glob@13.0.6`, `minimatch@10.2.4`, `tar@7.5.11`, and | ||
| `brace-expansion@5.0.4`, so those tarball-replacement patch steps are | ||
| removed. The `ip-address` and `picomatch` patches are retained because the | ||
| bundled versions (10.1.0 and 4.0.3 respectively) are still vulnerable. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ## 2.9.4 | ||
| **`(chore):`** Bump the PHP SDK and PHP model generator containers' Node base image from | ||
| `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the generators | ||
| with the rest of the Fern generator containers on a single Node major | ||
| version (Node 24) and picks up Node 24's CVE patches. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## 5.12.4 | ||
| **`(chore):`** Bump the Python SDK generator container's Node base image from | ||
| `node:22.22-bookworm-slim` to `node:24.15-trixie-slim`. Aligns the | ||
| generator with the rest of the Fern generator containers on a single | ||
| Node major version (Node 24) and Debian release (trixie). Trixie ships | ||
| patched versions of glibc, dpkg, nghttp2, libcap2, systemd, libgcrypt20, | ||
| krb5, curl, and expat that are not available on bookworm, clearing the | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
| AWS Inspector findings that dist-upgrade alone could not. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## 0.36.5 | ||
| **`(chore):`** Bump the Rust SDK and Rust model generator containers' Node base image from | ||
| `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the generators | ||
| with the rest of the Fern generator containers on a single Node major | ||
| version (Node 24) and picks up Node 24's CVE patches. The Rust SDK's | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
| in-place `npm@11.13.0` self-upgrade and the bundled `ip-address` patch are | ||
| retained because the Node 24 `npm` ship (`11.12.1`) still vendors | ||
| `ip-address@10.1.0`, which is vulnerable to GHSA-v2v4-37r5-5v8g. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
||
| ## 0.36.4 | ||
| **`(chore):`** Bump the rust toolchain stage in the rust-sdk and rust-model generator | ||
| containers from `rust:1.82-alpine3.20` to `rust:1.91-alpine3.23`. Alpine | ||
| 3.20 is EOL and ships outdated openssl/musl/busybox/zlib/curl/git; 1.91 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
| is the lowest rust version Docker Hub publishes for alpine3.23. The | ||
| Node runtime stage was already on `node:22.22-alpine3.23`, so there is | ||
| no longer any Alpine 3.20 layer anywhere in these images. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ## 0.35.5 | ||
| **`(chore):`** Bump the Swift SDK and Swift model generator containers' Node base image | ||
| from `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the | ||
| generators with the rest of the Fern generator containers on a single Node | ||
| major version (Node 24) and picks up Node 24's CVE patches. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| ## 3.70.5 | ||
| **`(chore):`** Bump the TypeScript SDK validator container's Node base image to | ||
| `node:24.15-trixie-slim`. Aligns the validator with the rest of the | ||
| Fern generator containers on a single Node major version (Node 24) on | ||
| top of the trixie-slim base introduced for `typescript-sdk-cli` and | ||
| `typescript-sdk-validator` by PR #15779. | ||
|
|
||
|
|
||
| ## 3.70.4 | ||
| **`(chore):`** Bump the typescript-sdk-cli and typescript-sdk-validator container base | ||
| images from `node:*-bookworm-slim` to `node:*-trixie-slim`. Trixie ships | ||
| patched versions of glibc, dpkg, nghttp2, libcap2, systemd, libgcrypt20, | ||
| krb5, curl, and expat that are not available on bookworm, so dist-upgrade | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
| alone is a no-op for those AWS Inspector findings — the base-image bump | ||
| is what actually clears them. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.