-
Notifications
You must be signed in to change notification settings - Fork 7
Update self-hosted changelog: v0.114.50 #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 all commits
6fe60cd
16410ca
4914d57
bcad8c7
34839f7
2bb9258
f516a31
69867e4
f0a082b
981ca1f
b0b548d
fb7d1e1
fb7e22a
d44c4b9
250a73e
7534186
c91113b
9676969
a5b09c5
d558c7e
b59a7ba
d558a34
7095515
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 |
|---|---|---|
|
|
@@ -6,11 +6,15 @@ description: A Slack-based technical writing agent that updates your documentati | |
|
|
||
| Fern Writer is a Slack-based technical writing agent that keeps your docs aligned as your product evolves. It's powered by [Devin from Cognition](https://cognition.ai/blog/introducing-devin). Fern Writer understands Fern components and your writing style, and can be customized via an `AGENTS.md` file in your docs repository. | ||
|
|
||
| <Frame caption="Tag Fern Writer and describe the change. Fern Writer creates a PR." > | ||
| <img | ||
| src="./writer-slack.png" | ||
| alt="Fern Writer in Slack" | ||
| /> | ||
| <Frame> | ||
| <video | ||
| src="fern-writer.mp4" | ||
| autoPlay | ||
| loop | ||
| playsInline | ||
| muted | ||
| > | ||
| </video> | ||
| </Frame> | ||
|
|
||
| ## How it works | ||
|
|
@@ -19,34 +23,8 @@ Fern Writer is a Slack-based technical writing agent that keeps your docs aligne | |
|
|
||
| In Slack channels where you've added Fern Writer, tag `@Fern Writer` and describe the change you need. Fern Writer [only responds when directly tagged](#privacy-and-data-handling). It will react to your message to confirm receipt, then create a pull request and reply with a link. | ||
|
|
||
| <Frame caption="Fern Writer creates a new PR in your docs repo."> | ||
| <img | ||
| src="./writer-open-pr.png" | ||
| alt="Fern Writer opening a PR" | ||
| /> | ||
| </Frame> | ||
|
|
||
| Fern Writer supports image and file attachments for additional context. When tagged in an existing thread, it reads the full conversation to understand context before responding. | ||
|
|
||
| | Use case | Sample request | | ||
| |----------|----------------| | ||
| | Document a new feature from a pull request | `@Fern Writer document the new rate limiting feature added in PR #123` | | ||
| | Add new content to existing pages | `@Fern Writer add a section about webhook retry behavior to the webhooks guide` | | ||
| | Reorganize and consolidate content | `@Fern Writer merge the authentication and authorization pages, and add a redirect from the old auth page` | | ||
| | Fix errors and improve clarity | `@Fern Writer fix the broken code example in the quickstart and update the package version to v2.1.0` | | ||
|
|
||
| <Accordion title="Video example"> | ||
| <video | ||
| src="fern-writer.mp4" | ||
| autoPlay | ||
| loop | ||
| controls | ||
| playsInline | ||
| muted | ||
| > | ||
| </video> | ||
| </Accordion> | ||
|
|
||
| ### Reviewing and merging | ||
|
|
||
| Request changes by commenting in the Slack thread. Once the PR meets your requirements, merge it like any other pull request. | ||
|
|
@@ -62,6 +40,30 @@ Request changes by commenting in the Slack thread. Once the PR meets your requir | |
|
|
||
| Each pull request includes a **Requested by** field in the description, attributing the change to the person or team that initiated the request. Commits are signed and attributed to `fern-support`, ensuring that automated changes are clearly distinguishable from manual contributions in your repository's history. | ||
|
|
||
| ## Example requests | ||
|
|
||
| <Prompt title="Document a new feature from a pull request"> | ||
| @Fern Writer document the new rate limiting feature added in PR #123 | ||
| </Prompt> | ||
|
|
||
| <br /> | ||
|
|
||
| <Prompt title="Add new content to existing pages"> | ||
| @Fern Writer add a section about webhook retry behavior to the webhooks guide | ||
| </Prompt> | ||
|
|
||
| <br /> | ||
|
|
||
| <Prompt title="Reorganize and consolidate content"> | ||
| @Fern Writer merge the authentication and authorization pages, and add a redirect from the old auth page | ||
|
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.
|
||
| </Prompt> | ||
|
|
||
| <br /> | ||
|
|
||
| <Prompt title="Fix errors and improve clarity"> | ||
| @Fern Writer fix the broken code example in the quickstart and update the package version to v2.1.0 | ||
| </Prompt> | ||
|
|
||
| ## Setup | ||
|
|
||
| <Info> | ||
|
|
||
| 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,23 @@ | ||
| ### v0.114.48 | ||
|
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.48 | ||
| ``` | ||
|
|
||
| Digest: `sha256:46ff081497e53f7fd574fb9cc2b3463761ef4214430246b82d4587f206020079` | ||
|
|
||
| ### v0.114.49 | ||
|
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.49 | ||
| ``` | ||
|
|
||
| Digest: `sha256:392c78851ff5c6964b6973ebf4e8042b52f3e6d7e2404ed36badd00c4fa9e8d0` | ||
|
|
||
| ### v0.114.50 | ||
|
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.50 | ||
| ``` | ||
|
|
||
| Digest: `sha256:8b204fd8cf4a0b47feb6143c7f32859eb81f5a602288d2f087b9d75c6c38718f` | ||
| 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 🐶 |
||
|
|
||
|
|
||
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'.