fix(docs): correct inaccurate autorelease documentation#4500
Merged
Conversation
- Remove fabricated cron/pull-based detection configuration (not in schema)
- Fix autorelease type from 'boolean | object' to 'boolean' in generators.yml reference
- Replace non-existent versioning types with semantic versioning
- Remove unverifiable claims about pause/confirmation and credential access
- Add missing 'Disable autorelease' section (linked from CLI changelog)
- Fix Vale warning ('currently')
Co-Authored-By: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1774276308-fix-autorelease-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
fern-support
approved these changes
Mar 23, 2026
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.
Summary
Fixes inaccuracies in the autorelease docs page and the
generators.ymlreference page by removing content that doesn't match the actual schema/implementation.Verified against the source schema (
fern-api/fern):autoreleaseisoptional<boolean>at both the global level (GeneratorsConfigurationSchema) and the per-generator level (GeneratorInvocationSchema). There is no object form.Changes:
autorelease.cron.scheduleobject doesn't exist in the schema. Removed from both the overview page and the reference page (2 accordions).boolean | object→booleanin thegenerators-yml-reference.mdxParamFields.#disable-autoreleasewhich didn't exist. The feature itself is real (autorelease: falseper-generator).Review & Testing Checklist for Human
autorelease: falseon a per-generator basis correctly overrides a globalautorelease: true.Notes
The link in the CLI changelog entry (2025-12-11) to
#disable-autoreleaseshould now resolve correctly with the new section added.Link to Devin session: https://app.devin.ai/sessions/7fbf767547a6450dbdfe5a695801a97c
Requested by: @Swimburger