Clarify MCP plans, schema directive editors, SDK naming, and generated … - #6822
Open
fern-api[bot] wants to merge 1 commit into
Open
Clarify MCP plans, schema directive editors, SDK naming, and generated …#6822fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
…xtensions, and generated CI Co-Authored-By: bot_apk <apk@cognition.ai>
|
|
||
| Fern auto-generates tests that must pass before SDK release. Fern generates a GitHub workflow in each SDK repository that runs unit tests and any enabled mock server tests on every pull request, commit, and release. | ||
|
|
||
| CI is generated automatically. When you enable generated tests, Fern writes a `.github/workflows/ci.yml` file into your SDK repository alongside the SDK code. You do not need to configure GitHub Actions yourself. If you add custom tests, include their files in `.fernignore` to prevent them from being overwritten on the next generation. |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'don't' instead of 'do not'.
Suggested change
| CI is generated automatically. When you enable generated tests, Fern writes a `.github/workflows/ci.yml` file into your SDK repository alongside the SDK code. You do not need to configure GitHub Actions yourself. If you add custom tests, include their files in `.fernignore` to prevent them from being overwritten on the next generation. | |
| CI is generated automatically. When you enable generated tests, Fern writes a `.github/workflows/ci.yml` file into your SDK repository alongside the SDK code. You don't need to configure GitHub Actions yourself. If you add custom tests, include their files in `.fernignore` to prevent them from being overwritten on the next generation. |
| # yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json | ||
| ``` | ||
|
|
||
| This directive is recognized by the [YAML Language Server](https://github.com/redhat-developer/yaml-language-server), which powers YAML support in **VS Code** (via the YAML extension), **IntelliJ IDEA** (via the YAML/Ansible plugin), **Neovim**, and other editors that support the language server protocol. Once active, your editor will: |
Contributor
There was a problem hiding this comment.
📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶
'IDEA' has no definition.
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-09-02-fern-ai-2fbdc2-8787d192.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a plan-availability callout to the MCP server page (Ask Fern on Hobby, Team, and Enterprise); expanded the generators.yml schema directive tip to explain what it does, which editors support it (VS Code, IntelliJ, Neovim via YAML Language Server), and the CLI version that introduced it; added two sections to the OpenAPI method-names page comparing
x-fern-sdk-group-namewithx-fern-sdk-namespaceand showing how to rename schemas/response types withx-fern-type-name(linked to the schema-names page); and updated the SDK testing page to state that Fern writes.github/workflows/ci.ymlautomatically (no manual GitHub Actions setup) plus a note that the TypeScript SDK has no option to disable JSDoc comment generation.