Skip to content

fix(docs): correct inaccurate autorelease documentation#4500

Merged
Swimburger merged 1 commit into
mainfrom
devin/1774276308-fix-autorelease-docs
Mar 23, 2026
Merged

fix(docs): correct inaccurate autorelease documentation#4500
Swimburger merged 1 commit into
mainfrom
devin/1774276308-fix-autorelease-docs

Conversation

@Swimburger

@Swimburger Swimburger commented Mar 23, 2026

Copy link
Copy Markdown
Member

Summary

Fixes inaccuracies in the autorelease docs page and the generators.yml reference page by removing content that doesn't match the actual schema/implementation.

Verified against the source schema (fern-api/fern): autorelease is optional<boolean> at both the global level (GeneratorsConfigurationSchema) and the per-generator level (GeneratorInvocationSchema). There is no object form.

Changes:

  • Removed fabricated cron/pull-based detection config — the autorelease.cron.schedule object doesn't exist in the schema. Removed from both the overview page and the reference page (2 accordions).
  • Fixed type from boolean | objectboolean in the generators-yml-reference.mdx ParamFields.
  • Replaced non-existent versioning types ("calendar-based, integer, or custom") with "semantic version".
  • Removed unverifiable claims about pause/confirmation behavior and credential access model.
  • Added "Disable autorelease" section — the CLI changelog (2025-12-11) links to #disable-autorelease which didn't exist. The feature itself is real (autorelease: false per-generator).
  • Fixed Vale warning — removed "currently" from early access note.

Review & Testing Checklist for Human

  • Verify removed claims are actually wrong: I removed "Autorelease pauses and requests confirmation if it's uncertain about the version bump" and "Publishing uses tokens stored in your GitHub Actions secrets—Fern never has access to these credentials." These couldn't be verified in the CLI code, but they could be accurate server-side behaviors. Someone who knows the autorelease backend should confirm these should stay removed.
  • Verify the "Disable autorelease" section is accurate: Confirm that setting autorelease: false on a per-generator basis correctly overrides a global autorelease: true.
  • Check the preview deployment to confirm the page renders correctly after removing the AccordionGroup wrapper and promoting sections to h3 headings.

Notes

The link in the CLI changelog entry (2025-12-11) to #disable-autorelease should now resolve correctly with the new section added.

Link to Devin session: https://app.devin.ai/sessions/7fbf767547a6450dbdfe5a695801a97c
Requested by: @Swimburger


Open with Devin

- 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>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

@Swimburger Swimburger merged commit aa8e615 into main Mar 23, 2026
4 checks passed
@Swimburger Swimburger deleted the devin/1774276308-fix-autorelease-docs branch March 23, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants